Express no Estress is an Express Based API skeleton. This project can be used for creating a RESTful API using NodeJS, express as the framework, mongoose MongoDB ODM with great packages for handle secutiry like helmet and hpp also others like body-parser, cookie-parser cors. cucumber is used for running integration tests for the endpoints and swagger for docs byside passport for handle user authentication.

It have a helper command to make all the files with a basic setup for a CRUD service

The resulting API from this project is a JSON RESTful API which will respond to requests over HTTP(s)

In computer programming, an Application Programming Interface (API) is a set of clearly defined methods of communication between various software components. A good API makes it easier to develop a computer program by providing all the building blocks, which are then put together by the programmer. An API may be for a web-based system, operating system, database system, computer hardware or software library. Just as a graphical user interface makes it easier for people to use programs, application programming interfaces make it easier for developers to use certain technologies in building applications. - Wikipedia

Representational state transfer (REST) or RESTful web services is a way of providing interoperability between computer systems on the Internet. REST-compliant Web services allow requesting systems to access and manipulate textual representations of Web resources using a uniform and predefined set of stateless operations. - Wikipedia

• api
  • controllers
  • docs
  • events
  • helpers
  • loaders
  • models
  • routes
  • services
  • public
  • validations
• config
• features
• template

The easiest way to get started is to clone the repository from GitHub and install the dependencies.

# Get the latest snapshot
$ git clone https://github.com/abellsmythe/express-no-stress.git myproject

# Change directory
$ cd myproject

# Install NPM dependencies
$ npm install

# Then simply start your app
$ node app.js

Then generate your first API endpoint

$ npm run make:resource Test

Try out your new endpoint.

Start the app

$ npm start

by default, the app will start on PORT 3000

You can change the PORT by adding a PORT environment variable. eg.

$ PORT=6000 npm start

now the app will start on PORT 6000

To config all the environments variables cp the .env.example to .env and replace what you need

$ cp .env.example .env

You will now be able to access CRUD (create, read, update and delete) endpoints

• [POST] http://localhost:3000/test Create test resource
• [GET] http://localhost:3000/test/search/:search? Get test resources. Supports search
• [GET] http://localhost:3000/test/:id Get a test resource
• [PUT] http://localhost:3000/test/:id Update one test resource
• [DELETE] http://localhost:3000/test/:id Delete one test resource

Easy generate your API endpoint

$ npm run make:model Test
$ npm run make:service Test
$ npm run make:controller Test
$ npm run make:routes Test
$ npm run make:events Test
$ npm run make:validations Test
$ npm run make:docs Test
$ npm run make:resource Test

You can find more information running

$ npm run make --help

You can create multiple versions of your API endpoints by simply adding the version number to your route file name. eg. users.v1.js will put a version of the users resources on the /v1/users endpoint. users.v2.js will put a version of the users resources on the /v2/users endpoint. The latest version of the resources will always be available at the /users endpoint.

NOTE: This project will automatically load route files found in the routes folder.

All generated endpoints come with complete test suits, we encourage you to update the tests as you extend the logic

$ npm test

If something is confusing, unclear or needs to be refactored, please let me know. Pull requests are always welcome. Please open an issue before submitting a pull request.

Alton Bell Smythe