BALANCE TON BUG

BTB API built in JS

TODO

• email verification

ONGOING

• Image sharing : need more tools to handle validation

To be improved

• Cascade deletes

Done

• Rooms
• Tickets mechanics
• Use env variable for secret keys etc

Dropped

• Separate app and server : not really useful

Installation guide

Requirements

Required

• NodeJS
• npm
• mongoDB

Useful

• Postman (for dev)
• mongo Compass

Start guide

• Clone the project : https://github.com/pidakichi/btb_app.git
• Create ".env" at the root of the project

Required fields : APP_NAME= name of the app NODE_ENV= environment PORT= port number

ENDPOINT= _endpoint, if in local, use http://localhost

JWT_SECRET= secret key for JWT creation

DB_CONNEXION= db used, by default, use "mongo" DB_HOST= db host, if in local use "localhost" DB_PORT= your mongodb port, by default 27017 DB_DATABASE= name of your database

CLOUDINARY_NAME= not used yet, enter whatever CLOUDINARY_API_KEY= not used yet, enter whatever CLOUDINARY_API_SECRET= not used yet, enter whatever CLOUDINARY_URL= not used yet, enter whatever

• Open command line at the root, run "npm install"
• Run "npm start" or "npm run start-dev" for development (using Nodemon and auto server refresh)
• done, you can now curl or use postman to use the API