Welcome to the FullStack Backend Challenge! This repository contains the backend code for the technical assessment interview. Please follow the instructions below to set up and run the project.
- Node.js v20.9.0 ( NVM version 1.1.11)
- NPM v10.2.1
-
Clone the Repository:
git clone https://github.com/Davidongo93/FullStack-Backend-Challenge.git
-
Navigate to the Project Directory:
cd FullStack-Backend-Challenge
-
Install Dependencies:
npm install
-
Run the Project:
npm start
The application will start, and you can access it at http://localhost:3000.
If you prefer using Insomnia, the API requests are available in the root of the project as an exported Insomnia workspace (Insomnia_collection.json
). Simply import this file into your Insomnia workspace.
If you prefer using curl
for making API requests, you can execute the provided shell script (api_requests.sh
). The default user passed as a parameter is set to "google" as per the guidelines. To run the script, use the following command:
./api_requests.sh
Ensure that the script has execution permissions:
chmod +x api_requests.sh
Please note that the base URL for the API is set to http://localhost:3000
. If your API is running on a different host or port, update the BASE_URL
variable in the script accordingly.
- The main backend code is located in the
src
folder. - Additional files related to the technical challenge are stored in the
misc
folder.
- For a correct view of ER diagram in
misc/04-ER-VideoAPP-Diagram.drawio
please install the VScode Plugin of drawio or visit: https://app.diagrams.net/