TickTuk User Management Service

A robust service built with Fastify and TypeScript for managing user authentication, authorization, and profile management in the TickTuk application.

🚀 Features

• User registration and authentication
• JWT-based authorization
• RESTful API endpoints
• Swagger documentation
• Redis for state synchronization
• Load balancing with Nginx
• Docker containerization
• Clean architecture with repository pattern

🛠 Tech Stack

• Runtime: Node.js (>=20.0.0)
• Framework: Fastify
• Language: TypeScript
• State Store: Redis
• Authentication: JWT (@fastify/jwt)
• Documentation: Swagger/OpenAPI
• Container: Docker & Docker Compose
• Load Balancer: Nginx
• Code Quality: ESLint, Prettier

🏗 Project Structure

src/
├── config/     # Configuration files (Redis, etc.)
├── repositories/ # Data access layer with generic repository pattern
├── services/   # Business logic layer
├── routes/     # API endpoints and request handlers
├── plugins/    # Fastify plugins (auth, cors, etc.)
├── schemas/    # Request/Response validation schemas
├── types/      # TypeScript type definitions
└── index.ts    # Application entry point

🚀 Getting Started

Prerequisites

• Node.js >= 20.0.0
• Redis
• Docker & Docker Compose (for containerized deployment)

Local Development

1. Clone the repository:

   git clone https://github.com/Danimaxpd/TickTuk-BackEnd
   cd ticktuk-user-management

2. Install dependencies:

   npm install

3. Create a .env file:

   • Docker already has the variables

   REDIS_URL=redis://localhost:6379
   JWT_SECRET=your-secret-key
   API_KEY=your-api-key

4. Start development server:

   npm run dev

Docker Deployment

Deploy the entire stack with load balancing:

docker-compose up -d

This will start:

• 2 API instances for high availability
• Redis instance for state synchronization
• Nginx load balancer

📚 API Documentation

Once running, access the Swagger documentation at: http://localhost/documentation

Available Endpoints

• POST /users - Create new user
• GET /users - List all users
• DELETE /users/:id - Delete user

🧪 Available Scripts

• npm run dev - Start development server
• npm run build - Build for production
• npm start - Start production server
• npm test - Run tests
• npm run lint - Run ESLint
• npm run format - Format code with Prettier
• npm run clean - Clean build directory

🔒 Security Features

• JWT-based authentication
• Password hashing
• Input validation with JSON schemas
• CORS protection
• Environment variable configuration
• Secure HTTP headers with Nginx

🐳 Docker Configuration

The service is containerized with:

• Multi-container setup using Docker Compose:
  • 2 API instances for high availability
  • Redis for in-memory state synchronization
  • Nginx load balancer with round-robin distribution
• Isolated network with internal service discovery
• Health monitoring for all services
• Automatic container restart on failure

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

👤 Author

David Jimenez

• Email: danimax.com@gmail.com
• GitHub: @danimaxpd