Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

• Node.js
• npm (Node Package Manager)

Installing

1. Clone the repository to your local machine:

   git clone https://github.com/your/repository.git
   cd repository

2. Install project dependencies:

   npm install

3. Start the development server:

   npm run dev

   This command uses nodemon to automatically restart the server when changes are detected.

Contribution

1. Create a branch for your contribution:

   git checkout -b your-branch-name

2. Make your changes and commit them:

   • Note: Please run npm run lint-format && npm run lint:fix to ensure your code follows our linting standards. and fix it first

   git add .
   git commit -m "Add a concise commit message"

3. Push your branch to the repository:

   git push -u origin your-branch-name

4. Open a pull request through the GitHub interface.

Code Style and Conventions

• Please run npm run lint-format to ensure your code follows our linting standards.