Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shadmanshakib/shakib-auth
Authentication build with Nestjs
https://github.com/shadmanshakib/shakib-auth
api authentication authorization backend jwt mit-license mvp nestjs saas typescript
Last synced: 6 days ago
JSON representation
Authentication build with Nestjs
- Host: GitHub
- URL: https://github.com/shadmanshakib/shakib-auth
- Owner: ShadmanShakib
- License: mit
- Created: 2024-12-28T09:13:30.000Z (8 days ago)
- Default Branch: main
- Last Pushed: 2024-12-28T09:21:13.000Z (8 days ago)
- Last Synced: 2024-12-28T10:19:53.250Z (8 days ago)
- Topics: api, authentication, authorization, backend, jwt, mit-license, mvp, nestjs, saas, typescript
- Language: TypeScript
- Homepage:
- Size: 228 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ShakibAuth
## Support
- [x] Authentication
- [x] Authorization
- [x] User Management
- [x] Role-Based Access Control
- [x] Password Reset
- [x] Email Verification
- [x] Two-Factor Authentication
- [x] Social Login (Google, Facebook, etc.)
- [x] API Documentation
## Project Overview
This project is an authentication service built using NestJS and MongoDB. It provides secure authentication and authorization features for applications.
## Installation Instructions
1. Clone the repository:
```bash
git clone
```
2. Navigate to the project directory:
```bash
cd
```
3. Install dependencies:
```bash
npm install
```
4. Set up environment variables by creating a `.env` file based on the `.env.example` file.
## Usage
To start the application, run:
```bash
npm run start
```
## API Documentation
- **POST /auth/login**: Authenticate a user.
- **POST /auth/register**: Register a new user.
- **GET /auth/profile**: Get the authenticated user's profile.
## Configuration
Ensure the following environment variables are set in your `.env` file:
- `MONGODB_URI`: The connection string for your MongoDB database.
- `JWT_SECRET`: The secret key for signing JWT tokens.
## Give a star
If you like this project, please give it a star.
## License
This project is licensed under the MIT License.