README.md

Travelmate - Contributing Guide

Welcome to the Travelmate project! This guide provides step-by-step instructions for contributing to the project.

Please make sure to read the following documents to get an overview of the project:

• Project Kick-off and Big Picture Overview
• Purpose, Scope, Target Users, Use Cases, and Key Features / USP
• Technology Stack

Getting Started

Step 1: Clone the project repository

Clone the Travelmate project repository to your local machine using the following command:

git clone https://github.com/peuan/travelmate-api.git

Step 2: Install dependencies

Navigate to the project directory and install all the required dependencies:

cd travelmate-api
npm run install

Step 3: Run the development server

• copy env.example to .env run

cp .env.example .env
docker-compose up

Folder Structure

• core
  • for initialize core modules that use as a global such as database config
• modules
  • for custom module such as user, product etc
• common
  • for code base that use as a global such as global enum, global dto
• migrations
  • for database migrations
  • to create a new migration run

    npm run migration:create --name={migration name} 
    #for example
    npm run migration:create --name=create-user-table 

  • to apply to database stop docker and run

    docker-compose up

Conventional Commits and Changelog

npm run commit