Skip to content

Latest commit

 

History

History
38 lines (25 loc) · 2.69 KB

README.md

File metadata and controls

38 lines (25 loc) · 2.69 KB
Raw

hello

This project was generated with BàngáJS v1.1.0.

Installation

  1. Install dependencies - npm install

  2. Create a new file .env if it doesn't exist and copy the contents of env.dev into it to be able to run your server on production environment.

  3. Then you need to provide values for the configuration env files at the src/config/env directory.

Running the server locally

  1. Start up the server - Run npm start | npm run dev

  2. Server should be running on http://localhost:2020/ by default

Code scaffolding

Run banga generate <type> <name> to generate a new file types. Visit here for more info.

Routes

Routes Description Auth roles
[POST]   /api/auth/sign-up Create a new account none
[POST]   /api/auth/sign-in User sign in none
[POST]   /api/auth/request-email-verification Resend verfication email none
[POST]   /api/auth/verify-email Email verification none
[POST]   /api/auth/request-password-reset Sends a request password email none
[POST]   /api/auth/reset-password Reset password form handler none
[POST]   /api/users Create a user User
[GET]   /api/users Get all users Admin
[GET]   /api/users/:userId Get a user User
[UPDATE]   /api/users/::userId Update a user User
[DELETE]   /api/users/:userId Delete a user Admin