Skip to content

Latest commit

 

History

History
114 lines (89 loc) · 7.51 KB

README.md

File metadata and controls

114 lines (89 loc) · 7.51 KB
Raw

Node API boilerplate

An opinionated boilerplate for Node web APIs focused on separation of concerns and scalability.

Features

Multilayer folder structure
Code organization inspired by DDD and Clean Architecture focused on codebase scalability.
Instant feedback and reload
Use Nodemon to automatically reload the server after a file change when on development mode, makes the development faster and easier.
Ready for production
Setup with PM2 process manager ready to go live on production. It's also out-of-box ready to be deployed at Heroku, you can read more about it here.
Scalable and easy to use web server
Use Express for requests routing and middlewares. There are some essential middlewares for web APIs already setup, like body-parser, compression, CORS and method-override.
Database integration
Sequelize, an ORM for SQL databases, is already integrated, you just have to set the authentication configurations.
Prepared for testing
The test suite uses Mocha/Chai and is prepared to run unit, integration and functional tests right from the beginning. There are helpers to make it easy to make requests to the web app during the tests and for cleaning the database after each test. A FactoryGirl adapter for Sequelize is setup to make your tests DRY as well, and the tests generate code coverage measurement with Istanbul. You should read about the Chai plugins that are setup by default too.
Dependency injection
With Awilix, a practical dependency injection library, the code will not be coupled and it'll still be easy to resolve automatically the dependencies on the runtime and mock them during the tests. It's even possible inject dependencies on your controllers with the Awilix Express adapter. Click here if you want to read more about how to use dependency injection with this boilerplate.
CLI integration
Both the application and Sequelize have command-line tools to make it easy to work with them. Check the Scripts section to know more about this feature.
Logging
The Log4js logger is highly pluggable, being able to append the messages to a file during the development and send them to a logging service when on production. Even the requests (through morgan) and queries will be logged.
Linter
It's also setup with ESLint to make it easy to ensure a code styling and find code smells.

Quick start

Notice that the boilerplate comes with a small application for user management already, you can delete it with a npm script after you understand how the boilerplate works but please do the quick start first! 😊

  1. Clone the repository with git clone --depth=1 https://github.com/talyssonoc/node-api-boilerplate
  2. Setup the database on config/database.js (there's an example file there to be used with PostgreSQL 😉 )
  3. Install the dependencies with yarn (click here if you don't have Yarn installed)
  4. Create the development and test databases you have setup on config/database.js
  5. Run the database migrations with npm run sequelize db:migrate
  6. Add some seed data to the development database with npm run sequelize db:seed:all
  7. Run the application in development mode with npm run dev
  8. Access http://localhost:3000/api/users and you're ready to go!

After playing a little bit with the boilerplate and before implementing a real application with it I recommend you to read at least the Setup and the Organization and architecture sections of our Wiki. After that you'll be able to remove the example application files running npm run cleanup

Aditional info:

  • Don't forget to run the migrations for the test environment as well (including when you create a new migration) with npm run sequelize db:migrate -- --env=test

Scripts

This boilerplate comes with a collection of npm scripts to make your life easier, you'll run them with npm run <script name> or yarn run <script name>:

  • dev: Run the application in development mode
  • start Run the application in production mode (prefer not to do that in development)
  • test: Run the test suite
  • test:unit: Run only the unit tests
  • test:features: Run only the features tests
  • coverage: Run only the unit tests and generate code coverage for them, the output will be on coverage folder
  • lint: Lint the codebase
  • sequelize: Alias to the Sequelize CLI
  • console: Open the built-in console, you can access the DI container through the container variable once it's open, the console is promise-friendly. Click here to know more about the built-in console
  • cleanup: Removes the files from the example application

Tech

Contributing

This boilerplate is open to suggestions and contributions, documentation contributions are also important! :)