2. Install Dependencies

npm install

3. Environment Configuration

Create a .env file in the root directory and configure the following variables:

# Database
DATABASE_URL="postgresql://username:password@localhost:5432/your_database_name"

# Server Configuration
PORT=5000
API_WEBSITE_URL="http://localhost:5000"
FRONTEND_WEBSITE_URL="http://localhost:3000"

# JWT Configuration
JWT_SECRET="your-super-secret-jwt-key"
JWT_EXPIRES_IN="7d"

# Google OAuth (Optional)
GOOGLE_CLIENT_ID="your-google-client-id"
GOOGLE_CLIENT_SECRET="your-google-client-secret"

# Email Configuration (SMTP)
EMAIL_HOST="smtp.gmail.com"
EMAIL_PORT=587
EMAIL_USER="your-email@gmail.com"
EMAIL_PASS="your-email-password"
EMAIL_FROM="noreply@yourapp.com"

# Environment
NODE_ENV="development"

4. Database Setup

# Generate Prisma client
npm run prisma:generate

# Run database migrations
npm run prisma:migrate

# (Optional) Open Prisma Studio to view your data
npm run prisma:studio

5. Start the Development Server

npm run dev

Your server will be running at http://localhost:5000 (or your configured PORT).

📁 Project Structure

backend/
├── src/
│   ├── config/
│   │   ├── config.ts          # Environment configuration
│   │   └── passport.ts        # Passport authentication strategies
│   ├── controllers/
│   │   └── authController.ts  # Authentication logic
│   ├── routes/
│   │   └── authRoutes.ts      # API routes
│   ├── services/
│   │   └── emailService.ts    # Email service functions
│   └── index.ts               # Application entry point
├── prisma/
│   ├── schema.prisma          # Database schema
│   └── migrations/            # Database migrations
├── .env                       # Environment variables
├── package.json
└── tsconfig.json

🔌 API Endpoints

Authentication Endpoints

Email & Password Management

📝 API Usage Examples

Register a New User

curl -X POST http://localhost:5000/api/auth/register \
  -H "Content-Type: application/json" \
  -d '{
    "name": "John Doe",
    "email": "john@example.com",
    "password": "securePassword123",
    "confirm_password": "securePassword123"
  }'

Login

curl -X POST http://localhost:5000/api/auth/login \
  -H "Content-Type: application/json" \
  -d '{
    "email": "john@example.com",
    "password": "securePassword123"
  }'

Access Protected Route

curl -X GET http://localhost:5000/api/auth/me \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

🛠️ Available Scripts

🔧 Configuration

Database Models

The application uses the following Prisma models:

• User: Core user information and authentication data
• Account: OAuth provider account linking
• Session: User session management
• VerificationToken: Email verification and password reset tokens

Authentication Strategies

• Local Strategy: Email/password authentication
• JWT Strategy: Token-based authentication for protected routes
• Google OAuth: Social login integration

🚀 Production Deployment

Environment Variables for Production

Ensure these environment variables are set in your production environment:

NODE_ENV="production"
DATABASE_URL="your-production-database-url"
JWT_SECRET="your-production-jwt-secret"
API_WEBSITE_URL="https://your-api-domain.com"
FRONTEND_WEBSITE_URL="https://your-frontend-domain.com"

Build and Start

# Build the application
npm run build

# Start production server
npm start

📝 License

This project is licensed under the MIT License.

🤝 Contributing

We welcome contributions! Please follow these steps:

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

🆘 Support

If you encounter any issues or have questions:

1. Check the Issues section
2. Create a new issue if your problem isn't already reported
3. Provide detailed information about your environment and the issue

🙏 Acknowledgments

• Passport.js – Authentication middleware for Node.js
• Express.js – Web framework for Node.js
• Nodemailer – Easy as cake email sending

⭐ Star this repo if you found it helpful!

Happy Coding! 🎉