Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shinniuwu/quickshield
This is a simple user management application built with Fastify, Prisma, and Node.js. It includes user registration, login, and password reset functionalities. The application is designed for personal use, but anyone is welcome to contribute and improve it!
https://github.com/shinniuwu/quickshield
api auth authentication contribute easyauth fastauth fastify nodejs performance prisma quickshield sql
Last synced: 19 days ago
JSON representation
This is a simple user management application built with Fastify, Prisma, and Node.js. It includes user registration, login, and password reset functionalities. The application is designed for personal use, but anyone is welcome to contribute and improve it!
- Host: GitHub
- URL: https://github.com/shinniuwu/quickshield
- Owner: ShinniUwU
- License: gpl-3.0
- Created: 2024-10-28T23:01:00.000Z (20 days ago)
- Default Branch: main
- Last Pushed: 2024-10-28T23:08:56.000Z (20 days ago)
- Last Synced: 2024-10-29T00:18:25.490Z (20 days ago)
- Topics: api, auth, authentication, contribute, easyauth, fastauth, fastify, nodejs, performance, prisma, quickshield, sql
- Language: TypeScript
- Homepage:
- Size: 58.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Fastify User Management Application
This is a simple user management application built with **Fastify**, **Prisma**, and **Node.js**. It includes user registration, login, and password reset functionalities. The application is designed for personal use, but anyone is welcome to contribute and improve it!
## Features
- User registration with email and password
- User login
- Forgot password functionality with email reset link
- Email sending functionality using SMTP
## Technologies Used
- Fastify: Web framework for Node.js
- Prisma: ORM for database access
- Bcrypt: Password hashing
- Crypto: Secure random tokens for user authentication for password resets
- Nodemailer: Email sending
- SMTP Server: For testing email functionality (which you need to provide)
## Getting Started
### Prerequisites
Before you begin, ensure you have the following installed:
- Node.js (v14 or higher)
- bun (optional)
- A relational database (e.g., PostgreSQL, MySQL, SQLite)
### Installation
1. **Clone the repository:**
```bash
git clone https://github.com/ShinniUwU/QuickShield.git
cd QuickShield
```
2. **Install dependencies:**
```bash
bun install
```
3. **Set up your database:**
Ensure you have a relational database set up and create a `.env` file in the root directory with the following variables:
```plaintext
DATABASE_URL="your_database_connection_string"
SMTP_HOST="your_smtp_host"
SMTP_PORT=465
SMTP_USER="your_email"
SMTP_PASS="your_email_password"
```
4. **Run Prisma migrations:**
If you have defined your Prisma schema, run the migrations:
```bash
npx prisma migrate dev --name init
```
5. **Start the server:**
```bash
bun run start
```
The server will start on `http://localhost:3000`.
### Endpoints
- **POST** `/register` - Register a new user.
- **Request Body:**
```json
{
"username": "exampleUser",
"email": "[email protected]",
"password": "yourPassword"
}
```
- **POST** `/login` - Login an existing user.
- **Request Body:**
```json
{
"email": "[email protected]",
"password": "yourPassword"
}
```
- **POST** `/forgot-password` - Request a password reset link.
- **Request Body:**
```json
{
"email": "[email protected]"
}
```
### License
This project is licensed under the MIT License. You are free to use, modify, and distribute it. Contributions are welcome!
### Contributing
If you'd like to contribute to this project, please fork the repository and submit a pull request with your changes.