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-web.git

Step 2: Install dependencies

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

cd travelmate-web
yarn install

Step 3: Run the development server

Start the development server by running the following command:

yarn dev

Open http://localhost:3000 in your browser to see the application in action.

Docker

To run the application using Docker, use the following command:

docker-compose up -d

Storybook

To design and customize UI components, use Storybook:

yarn storybook

Open http://localhost:6006 in your browser to access Storybook.

Playwright

For end-to-end testing, we use Playwright.

To open Playwright UI, run the following command:

yarn playwright-ui

Jest

Unit testing is performed using Jest.

To run tests in a CI environment, use the following command:

yarn test:ci

To generate a coverage report, run:

yarn test-report

Conventional Commits and Changelog

yarn commit