• Auth

  • Authenticate

• Beacon

  • Create beacon
  • Delete beacon
  • Retrieve beacon
  • Retrieve beacons
  • Update beacon

• User

  • Create user
  • Delete user
  • Retrieve current user
  • Retrieve user
  • Retrieve users
  • Update password
  • Update user

• Visitant

  • Create visitant
  • Retrieve visitant
  • Retrieve visitants
  • Update visitant

POST /auth

POST /beacons

DELETE /beacons/:id

GET /beacons/:id

GET /beacons

PUT /beacons/:id

POST /users

DELETE /users/:id

GET /users/me

GET /users/:id

GET /users

PUT /users/:id/password

PUT /users/:id

POST /visitantes

GET /visitantes/:id

GET /visitantes

PUT /visitantes/:id

After you generate your project, these commands are available in package.json.

npm test # test using Jest
npm run coverage # test and open the coverage report in the browser
npm run lint # lint using ESLint
npm run dev # run the API in development mode
npm run prod # run the API in production mode
npm run docs # generate API docs

First, you will need to install and run MongoDB in another terminal instance.

$ mongod

Then, run the server in development mode.

$ npm run dev
Express server listening on http://0.0.0.0:9000, in development mode

If you choose to generate the authentication API, you can start to play with it.

Note that creating and authenticating users needs a master key (which is defined in the .env file)

Here is an example on how to deploy to Heroku using Heroku CLI:

# start a new local git repository
git init

# create a new heroku app
heroku apps:create my-new-app

# add heroku remote reference to the local repository
heroku git:remote --app my-new-app

# add the MongoLab addon to the heroku app
heroku addons:create mongolab

# set the environment variables to the heroku app (see the .env file in root directory)
heroku config:set MASTER_KEY=masterKey JWT_SECRET=jwtSecret

# commit and push the files
git add -A
git commit -m "Initial commit"
git push heroku master

# open the deployed app in the browser
heroku open

The second time you deploy, you just need to:

git add -A
git commit -m "Update code"
git push heroku master

You can customize the src and api directories.

src/
├─ api/
│  ├─ user/
│  │  ├─ controller.js
│  │  ├─ index.js
│  │  ├─ index.test.js
│  │  ├─ model.js
│  │  └─ model.test.js
│  └─ index.js
├─ services/
│  ├─ express/
│  ├─ facebook/
│  ├─ mongoose/
│  ├─ passport/
│  ├─ sendgrid/
│  └─ your-service/
├─ app.js
├─ config.js
└─ index.js

Here is where the API endpoints are defined. Each API has its own folder.

It defines the Mongoose schema and model for the API endpoint. Any changes to the data model should be done here.

This is the API controller file. It defines the main router middlewares which use the API model.

This is the entry file of the API. It defines the routes using, along other middlewares (like session, validation etc.), the middlewares defined in the some-endpoint.controller.js file.

Here you can put helpers, libraries and other types of modules which you want to use in your APIs.