- This is the backend application for the Secret Santa project. The backend provides the necessary API routes for the frontend and includes a health check route.
- Ensure that you have Node.js and Yarn installed on your system.
-
Clone the Repository:
git clone <repository-url> cd <repository-directory>
-
Install Dependencies: In the terminal, type:
yarn
-
Available Scripts:
- Start the development server:
yarn dev
- Run tests:
yarn test
- Run tests in watch mode:
yarn test:watch
- Start the development server:
-
Run the Application:
- Start the server:
yarn dev
- Server runs on
http://localhost:4000
- Open
http://localhost:4000/health-check
in your browser to check the server health status.
- Start the server:
-
API Routes:
- To see all the visible routes
http://localhost:4000/routes
. - Use the
GET /health-check
endpoint to verify server health.
- To see all the visible routes