genevieveikechukwu / hng-task

hng-task

[!NOTE]

How to use: For fine Mentors 😏

UML Diagram

• Sequence Diagram 👈

Requirements:

• NodeJs
• Git (Optional but ideal)

Running the application

• Clone the repo
• cd into the repo
• npm install
• Duplicate the file named "example.env", rename the new copy to "config.env".
• Edit the content of the .env file with your own atlas db, can't share mine sorry 😏
• npm run dev
• You can start making requests by visiting http://127.0.0.1:8000/api

Running Tests on Postman

• Visit API Test 👈
• Click on run in postman by your top right
• Select which Postman app to use
• Import into a workspace
• Follow the instructions available on the collections
• You're all set 😊

Commit

The Format and Test hook will be run when creating a commit. if any fails, make fixes (If it has not been fixed already automatically) and then:

• git add .
• git commit -m "[Commit type]: [Message]"
• git push to your branch.

Daalu!! 🙇