/project-group3be

Backend documentation in swagger

Primary LanguageJavaScript

GooseTrack project backend repository

This project contains the backend part of the web application GooseTrack Task Planner. It provides user registration, authentication, management of reviews, and user tasks.

Installation and Usage

Make sure you have the LTS version of Node.js and npm installed. To obtain and run this project locally, follow these steps:

  1. Clone the repository Open your terminal and execute the command:

    git clone https://github.com/svrphoenix/project-group3be.git
  2. Navigate to the project folder Change to the created repository folder:

    cd project-group3be
  3. Install dependencies Use npm to install the necessary dependencies:

    npm install
  4. Start the server Launch the server in development mode using the command:

    npm run dev

Commands

  • npm start — start the server in production mode
  • npm run dev — start the server in development mode
  • npm run lint — run eslint code checking, execute before each PR and fix all lint errors
  • npm lint:fix — run lint checking with automatic fixes for simple errors

Backend Deployment

The backend component has been deployed on the Render.com server and is accessible at: https://goose-backend.onrender.com/.

API Documentation

For working with the project, documentation of endpoints has been created using Swagger UI. You can find it at this GooseTrack API Documentation

Backend Repository

Check out the frontend code at: GooseTrack Frontend Repository