Riwi CIne API

---

Table of Contents

• Project Description
• Technologies Used
• Architecture
• Key Features
• Documentation
• Installation
• Docker
• Contributors And Authors

---

Project Description

Riwi Cine API is a RESTful enterprise API for managing a sports movies platform:
products, orders, users, authentication, roles, and more.

Built with Node.js, TypeScript, and PostgreSQL under a modular and scalable architecture.
Its goal is to serve as a reliable backend for web or mobile applications.

Back to top

---

Technologies Used

Category	Technologies
Language	TypeScript
Runtime	Node.js
Framework	Express
Database	PostgreSQL + Sequelize
Authentication	JWT + bcrypt
Documentation	Swagger / OpenAPI
Testing	Jest
Containers	Docker / Docker Compose

Back to top

---

Architecture

app/src/
├── controllers/   # HTTP request handlers
├── repositories/  # Data access layer
├── dto/           # Data validation objects
├── models/        # Database models
├── routes/        # API endpoints
├── services/      # Business logic
├── middleware/    # Custom middlewares
└── seeders/       # Database seeders

Back to top

---

Key Features

• Modular Architecture: REPOSITORIES/DTO patterns with service layer
• Security: JWT authentication + RBAC authorization
• Validation: Automatic request validation with class-validator
• Documentation: Auto-generated Swagger docs
• Database: Automated migrations and seeders
• Testing: Jest configuration for unit tests

Back to top

---

Documentation

Detailed documentation available in /docs:

Back to top

---

Installation

# Clone repository
git clone <repository-url>
cd workdir

# Install dependencies
cd app && npm install

# Configure environment
cp .env.example .env

# Start with Docker
docker-compose up -d

# Or start in development mode
npm run dev

Back to top

---

Deploy all the project in Docker

Linux/macOS

# Start all services
docker-compose up -d

# View logs
docker-compose logs -f

# Stop services
docker-compose down

Windows (Command Prompt)

REM Start all services
docker-compose up -d

REM alternative
docker-compose up --build

REM View logs
docker-compose logs -f

REM Stop services
docker-compose down

Windows (PowerShell)

# Start all services
docker-compose up -d

# alternative
docker-compose up --build

# View logs
docker-compose logs -f

# Stop services
docker-compose down

Back to top

---

👥 Contributors And Authors

Author	Role	Path
Riwi Coders	Backend Developers	Node

Back to top

---

Made with by Riwi Developers