https://github.com/osamaadam/easy-gen
https://github.com/osamaadam/easy-gen
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/osamaadam/easy-gen
- Owner: osamaadam
- Created: 2025-03-30T00:04:22.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2025-04-01T04:26:57.000Z (3 months ago)
- Last Synced: 2025-04-01T05:26:35.886Z (3 months ago)
- Language: TypeScript
- Size: 188 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# EasyAuth
A full-stack authentication system built with React and NestJS.
## Overview
EasyAuth is a simple yet secure authentication system that demonstrates best practices for implementing user authentication in web applications. The project consists of:
- **Frontend**: React application with form validation and protected routes
- **Backend**: NestJS API with JWT authentication
- **Database**: MongoDB
## Project Structure
```text
easy-gen-auth/
├── server/ # NestJS backend
├── web/ # React frontend
├── compose.yml # Docker Compose configuration
└── README.md # This file
```
## Prerequisites
- Docker and Docker Compose
- Node.js v22+ and npm (for local development)
## Running with Docker
The easiest way to run the entire application stack is using Docker Compose:
1. Clone the repository:
```bash
git clone
cd easy-gen-auth
```
2. Start the application:
```bash
docker compose up -d
```
3. Access the application:
- Frontend:
- Backend API:
- API Documentation:
4. To stop the application:
```bash
docker compose down
```
## Development
For more information about developing each part of the application:
- [Web Frontend Documentation](./web/README.md)
- [Server Backend Documentation](./server/README.md)
## Environment Variables
The application uses the following environment variables (already set in the Docker Compose file):
### Backend
- `JWT_SECRET`: Secret key for JWT token generation
- `MONGO_URI`: MongoDB connection string
### Frontend
- `VITE_BACKEND_URL`: URL of the backend API