boilerplate-nodejs-swagger

KO | EN

gitlite — search

#python #java #python3 #arduino #golang #machine-learning #rust #html #flask #javascript #seismology #nodejs

boilerplate-nodejs-swagger

★ 24 Open GitHub ↗

A Node.js RESTful API application boilerplate with TypeScript, Docker, Koa, Swagger, Jest, and CircleCI

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<div align="center">
  <a href="https://github.com/qas/boilerplate-server-node-swagger-api" title="Node.js RESTful API Boilerplate w/Koa">
    <img alt="Koa REST API Boilerplate" src="http://crocodillon.com/images/blog/2015/asynchronous-callbacks-in-koa--twitter.png" width="240px" />
  </a>
  <br />
  <h1>Node.js RESTful API Boilerplate</h1>
</div>

Boilerplate for Node.js Koa RESTful API application with TypeScript, Docker, Swagger, Jest, and CircleCI.

<br />

**Koa REST API Boilerplate** is a highly opinionated boilerplate template for building a RESTful API application with TypeScript & Koa - this template comes loosely-typed.

This boilerplate includes the following features:

- [tsoa](https://github.com/lukeautry/tsoa) for autogenerated [Swagger](https://swagger.io/) documentation, routes, and request validation
- Style and linting with [Google TypeScript style](https://github.com/google/ts-style)
- Multi-process clustering with production-ready process manager [PM2](http://pm2.keymetrics.io/)
- Log rotation and log management using [Winston](https://github.com/winstonjs/winston)
- A tiny optimized [Docker](https://www.docker.com/) image based on Alpine image
- Continuous integration and delivery using [CircleCI](https://circleci.com/)
- Unit and Integration tests along with test Coverage using [Jest](https://facebook.github.io/jest/) testing framework

## Getting Started

```zsh
$ git clone https://github.com/https://github.com/qas/boilerplate-server-node-swagger-api your-project-name
$ cd your-project-name
$ rm -rf .git && git init
```

```zsh
$ yarn
$ yarn build
$ yarn start
```

## Commands

### Run

```zsh
# Run normally
$ yarn start
# Run the application with Docker for development with Nodemon
$ docker-compose up
$ curl localhost:7070/v1/spec
$ curl localhost:7070/v1/health
```

### Test

![sfrkh.png](http://i.xomf.com/sfrkh.png)

```zsh
# Test
$ yarn test                           # Run all test
$ yarn test:unit                      # Run only unit test
$ yarn test:e2e                       # Run only integration test
# Test (Watch Mode for development)
$ yarn test:watch                     # Run all test with watch mode
$ yarn test:watch:unit                # Run only unit test with watch mode
$ yarn test:watch:e2e                 # Run only integration test with watch mode
# Test Coverage
$ yarn test:coverage                  # Calculate the coverage of all test
$ yarn test:coverage:unit             # Calculate the coverage of unit test
$ yarn test:coverage:e2e              # Calculate the coverage of integration test
# Test consistent coding style (Lint)
$ yarn lint                           # Lint all sourcecode
```

### Archive

```zsh
$ yarn pack
```

## Contributing

This project follows the [**Contributor Covenant**](http://contributor-covenant.org/version/1/4/) Code of Conduct.

#### Bug Reports & Feature Requests

Please use the [issue tracker](https://github.com/qas/boilerplate-server-node-swagger-api/issues) to report any bugs or ask feature requests.

## License

Provided under the terms of the [MIT License](https://github.com/qas/boilerplate-server-node-swagger-api/blob/master/LICENSE).

boilerplate-nodejs-swagger

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README