https://github.com/ericnishio/express-boilerplate
A modern Express boilerplate for building RESTful APIs in TypeScript.
https://github.com/ericnishio/express-boilerplate
api authentication bcrypt boilerplate docker es2015 es6 express jwt minimal mongodb node rest restful typescript
Last synced: 6 months ago
JSON representation
A modern Express boilerplate for building RESTful APIs in TypeScript.
- Host: GitHub
- URL: https://github.com/ericnishio/express-boilerplate
- Owner: ericnishio
- License: mit
- Created: 2017-01-24T19:42:55.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2022-12-22T07:59:15.000Z (about 3 years ago)
- Last Synced: 2025-06-27T13:39:25.090Z (7 months ago)
- Topics: api, authentication, bcrypt, boilerplate, docker, es2015, es6, express, jwt, minimal, mongodb, node, rest, restful, typescript
- Language: TypeScript
- Homepage:
- Size: 827 KB
- Stars: 12
- Watchers: 0
- Forks: 3
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# 
[](https://snyk.io/test/github/ericnishio/express-boilerplate)
[](https://travis-ci.org/ericnishio/express-boilerplate)
A modern [Express](https://expressjs.com) boilerplate for building RESTful APIs in TypeScript.
- [TypeScript](https://www.typescriptlang.org/)
- ES6+, async/await, spread syntax, etc.
- [TSLint](https://palantir.github.io/tslint/)
- [JWT](https://jwt.io)-based authentication
- [Mongoose](http://mongoosejs.com)
- [Jest](https://facebook.github.io/jest/)
- [Winston](https://github.com/winstonjs/winston)
Requirements: [Node 6+](https://nodejs.org/en/download/), [Yarn](https://yarnpkg.com/en/docs/install), [Docker](https://www.docker.com)
## Install
```
yarn
cp .env.dev .env
```
## Start dev server
Run the tests once to start the database container:
```
./run-tests.sh
```
Then:
```
yarn start
```
## Build for production
```
yarn build
```
This creates a build in `dist`.
## Run tests
```
./run-tests.sh
```
## License
[MIT](LICENSE.md)