Skip to content
This repository has been archived by the owner on Feb 12, 2024. It is now read-only.

yaasiin-ayeva/Roulette-api

Repository files navigation

# express-boilerplate Node.js CI

Simple express rest api boilerplate with user authentication with JWT token & routes for forget password & password reset.

Presentation

Steps to run this project:

  1. Run :
npm i
  1. Please be sure to check you environment. Setup environnement settings are inside ./.env file

  2. Finally Run :

npm run dev

SRC Folder structure

Location Content
/src/.env Environnement settings
/assets/documents Document folder
/assets/pictures Pictures folder
/src/entity Entity files wrote with typeORM decorators
/src/services All services organized by entity with an index
/src/middlewares Middlewares for some services
/src/routes Routes organized by entity with an index
/src/index.js API Entry Point with server configurations
/src/dtos DTOs for entities
/src/configs Imported project configurations from an .env file

Please kindly respect this project architecture in your code maintenance.

IMPORTANT

Check /postman folder to get exported postman collection

About

API for Roulette Data

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published