lmachens / users-api

API example project

API Template

This project is a template for creating a new API based on Express.

ESLint, prettier, husky and lintstaged are configured to give you a solid development experience.

Installing / Developing

First, create a repository from this template.

Now you are ready to go:

npm install --no-save

This will install the dependencies required to run this project.

npm run dev

Boom! These scripts run your server in development mode.

Building

To build the project in the /dist folder, run:

npm run build

The production optimized project is runnable with:

npm start

Tests

A test runner is not installed (right now). But TypeScript, linter and prettier are checked on commit and push thanks to husky and lintstaged.

Licensing

MIT