Nerack Backend API

#Features

• Authentication & Authorization: JWT-based authentication with bcrypt password hashing
• Clean Architecture: Modular structure with feature-based organization
• API Documentation: Swagger/OpenAPI documentation
• Type Safety: Full TypeScript implementation
• Testing: Jest testing framework with unit and e2e tests
• Validation: Request/response validation with class-validator
• Configuration: Environment-based configuration management

#Quick Start

##Prerequisites

• Node.js 18+ and npm
• PostgreSQL database

##Installation

# Install dependencies
npm install

# Copy environment variables
cp .env.example .env

# Configure your database connection in .env
# DATABASE_URL="postgresql://username:password@localhost:5432/nerack_db"

# Start development server
npm run start:dev

##API Documentation

• Swagger UI: http://localhost:3000/api/docs
• API JSON: http://localhost:3000/api/docs-json

#Available Scripts

# Development
npm run start:dev      # Start with file watching
npm run start:debug    # Start in debug mode

# Production
npm run build          # Build the application
npm run start:prod     # Start production server

# Testing
npm run test           # Run unit tests
npm run test:watch     # Run tests in watch mode
npm run test:cov       # Run tests with coverage
npm run test:e2e       # Run end-to-end tests

# Code Quality
npm run lint           # Run ESLint
npm run format         # Format code with Prettier

#Project Structure

#API Endpoints

##Authentication

• POST /api/auth/register - User registration
• POST /api/auth/login - User login

##Users

• GET /api/users/profile - Get user profile
• PUT /api/users/profile - Update user profile

##Books (Coming Soon)

• GET /api/books - List user's books
• POST /api/books - Add new book
• PUT /api/books/:id - Update book
• DELETE /api/books/:id - Delete book

#Environment Variables

#Contributing

1. Follow the existing code style and architecture
2. Write tests for new features
3. Update documentation as needed
4. Ensure all tests pass before submitting

#License