Gift-BE

A RESTful backend service built with Express and TypeScript. This project demonstrates core backend concepts such as routing, middleware, validation, and database interaction using PostgreSQL. It serves as a showcase of my backend development skills.

Table of Contents

1. Technologies
2. Project Structure
3. Prerequisites
4. Setup and Running the App
5. Scripts

Technologies

• Express for building the REST API.
• TypeScript for type safety and better developer experience.
• PostgreSQL as the database
• bcrypt for password hashing.
• Zod for schema validation.
• Prisma for database ORM (generates types and queries).
• Docker for containerization and consistent development environments.

Project Structure

src/
├── config/         # Configuration files (e.g., environment setup)
├── controllers/    # Request handlers for specific routes (HTTP layer)
├── middleware/     # Custom middleware (e.g., auth, logging)
├── models/         # Database models (queries)
├── types/          # TypeScript type definitions
├── routes/         # Route definitions
├── services/       # Business logic and reusable services
├── utils/          # Utility functions
├── validations/    # Request validation logic

Prerequisites

Before you begin, make sure you have the following installed on your machine:

• Docker
• Docker Compose
• Node.js

Setup and Running the App

1. Clone the repository:

   git clone https://github.com/moodizone/gift-be.git
   cd gift-be
   docker-compose up --build

2. Create an .env file:

   # APP
   APP_PORT = "..."
   
   # DATABASE
   DB_PORT = "..."
   DB_NAME = "..."
   DB_USER = "..."
   DB_PASSWORD = "..."
   DATABASE_URL = "..." # for local development
   
   # AUTH
   SECRET_0 = "..."
   SECRET_1 = "..."
   SECRET_2 = "..."
   SECRET_3 = "..."
   SECRET_4 = "..."
   SECRET_POSITION = "..." # Number between 0-24
   

3. Start the containers:

   docker compose up --build
   

Scripts

• Generates the sdk.ts file, it can be used for FE projects that describes API input/output:

  npm run sdk