Challenge_backend

This repository contains the backend application of a Umurava challenge developped by CJJ-Team

• Table of content
  • Project Overview
  • Technology used
  • Using the project
    • Prerequisites
    • Installation
  • Contribution
    • Documentation
    • Deployed_link:
  • Licensing

1. Project Overview

Umurava challenge project

2. Technology used

• Frontend: HTML, CSS, Typescript(React)

Authentication: JWT for secure access control Email Notifications: Nodemailer for sending email notifications Hosting: Deployed on Netlify for the frontend and render for the backend.

• Node.js:

• Express:

• MongoDB Database:

• Testing by Jest:

3.Using the project

For those who are interested to use it locally,he/she is required the following:

* Prerequisites

• Node.js
• Packages
• Mongodb database
• Git

*Installation

1. Clone the repository from github https://github.com/Lapidis2/challenge_bn
2. Run npm install to install all package dependencies
3. Copy the environment configuration: cp .env.example .env you can update the values of .env file with yours.
4. To run mongodb use the following command: npm run dev
5. Run the project using this command npm start
6. running test by npm test

4.Contribution

To contribute to this project:

1. Clone the repository
2. Create your own branch to avoid direct pushing to main brach without creating pullrequest and get reviewed.

• feature(ft): git checkout -b ft-name-of-the-feature-bn-TrelloId
• chore(ch): git checkout -b ch-name-of-the-chore-bn-TrelloId
• bug(bd): git checkout -b bg-name-of-the-bug-bn-TrelloId

1. Then you can commit any changes you made by: git commit -m "your commit message"
2. Push your changes to the branch you created git push origin your-new-branch-name
3. create a pull request and wait for review from other collabolators

5.Documentation

The following are steps to create your api documentation:

• Navigate to the location src/api-docs. Create a .yaml file.
• Write your documentation in the file. No need to set up Swagger-related things in server.ts again.
  ⚠️ You must know that YAML strictly follows indentation

Deployed_link:https://umurava-skill-challenge.netlify.app

swagger-link:https:https://umurava-challenge-bn.onrender.com/api-docs/

6.Licensing

This project is licensed under the MIT License. See the LICENSE file for detail.