README.md

RESTful API Boilerplate

RESTful API Boilerplate and build process to quickly get projects going.

Features

Development tools:

• Webpack 5 as module bundler
• ES6 support via Babel
• Lint via ESLint - JavaScript Standard Style
• Unit tests via Jest - SuperTest

Frameworks/Libraries included:

• Express framework
• CORS support via cors
• Body Parsing via body-parser
• Secure your app via helmet
• Loads environment variables via dotenv

Installation

Clone the repository or download the latest stable release

git clone https://github.com/bymathias/rest-api-boilerplate.git api

Make it your own

cd api
rm -rf .git && git init && npm init

Then install dependencies

npm install

Usage

Development:

Watch/run the Express server for development

npm run dev

Run unit tests (Jest)

npm run test:watch
# OR
npm test

Production:

Build for production,

npm run build -- --mode=production

or edit the variable APP_BUILD_MODE in the .env file.

Run the Express server

npm start

Change Log

All notable changes to this project will be documented in the CHANGELOG.

Contributing

All types of contributions are most welcome.

• Project issue: Bug reports, feature requests, and feedback.
• Merge/Pull request: Bug fixes, new features and documentation.

License

The code is available under the MIT LICENSE.