Skip to content

A testable Node.js API boilerplate using Express and other goodies.

Notifications You must be signed in to change notification settings

patarkf/express-testable-api-boilerplate

Repository files navigation

Testable Node.js API Express Example

Coverage Status Build Status

This repository demonstrates the usage of Sequelize within an Express application. The implemented app is a simple beer registration tool.

Starting App

npm install
npm run db:migrate
npm start

By running these commands you will start the application and create an SQLite database in your app dir. Just open http://localhost:4000.

Running Tests

Tests are implemented with Jest and Supertest.

You can run all tests by npm test.

Environments

The app is based on three different environments: dev, test, and production.

For dev and test environments, the app will use an SQLite database, which as mentioned before, will be created in your app dir (it's just a binary file that can be deleted and replaced any time).

Also, the app will generate a different SQLite database depending on the environment you are on (dev or test), so you can run your tests with confidence, knowing that your dev database will keep untouched.

For production, there is some database environment variables you can set to configure your own instance.

About

A testable Node.js API boilerplate using Express and other goodies.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published