https://github.com/chunkai1312/api-boilerplate
A boilerplate for building api services based NodeJS, Express web framework and MongoDB
https://github.com/chunkai1312/api-boilerplate
api boilerplate express mongodb nodejs
Last synced: 20 days ago
JSON representation
A boilerplate for building api services based NodeJS, Express web framework and MongoDB
- Host: GitHub
- URL: https://github.com/chunkai1312/api-boilerplate
- Owner: chunkai1312
- Created: 2016-09-21T06:17:26.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2018-02-22T10:03:40.000Z (over 7 years ago)
- Last Synced: 2025-09-05T17:11:10.423Z (about 2 months ago)
- Topics: api, boilerplate, express, mongodb, nodejs
- Language: JavaScript
- Homepage:
- Size: 187 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# api-boilerplate
[![Build Status][travis-image]][travis-url]
[![Coverage Status][codecov-image]][codecov-url]
[![JavaScript Style Guide][standardjs-image]][standardjs-url]
> A boilerplate for building api services based NodeJS, Express web framework and MongoDB
## Features
- ES6/ES2015+ support with [Babel](https://babeljs.io)
- Application framework with [Express](http://expressjs.com)
- Database object modeling with [Mongoose](http://mongoosejs.com)
- Logging library with [Winston](https://github.com/winstonjs/winston)
- Application watching and restarting use in development mode with [Nodemon](https://github.com/remy/nodemon)
- Test Framework with [Jest](https://facebook.github.io/jest)
- Todo API implementation for example
## Requirements
* [Node.js](https://nodejs.org) v6+
* [Yarn](https://yarnpkg.com) or [NPM](https://www.npmjs.com)
* [MongoDB](https://www.mongodb.com)
## Installation
Clone this repo:
```
$ git clone https://github.com/punwave/punserve.git
$ cd
```
Install dependencies:
```
$ npm install
```
## Running the Project
|`yarn ` |Description|
|-------------------|-----------|
|`start` |Runs the application|
|`dev` |Runs the application in development mode with Nodemon|
|`build` |Builds the project for production|
|`test` |Runs unit tests with Jest|
|`test:watch` |Runs `test` in watch mode to re-run tests when changed|
|`test:coverage` |Runs `test` and generates code coverage report|
|`lint` |Lints the project for potential errors|
## Project Structure
```
.
├── bin
│ └── api # Application entry point
├── logs # Logging files
├── src # Application source code
│ ├── app # Application logic implementations
│ │ ├── controllers # Routing controller implementations
│ │ ├── middlewares # Connect/Express middleware implementations
│ │ ├── models # Schema/Entity definitions
│ │ ├── repositories # Repository implementations
│ │ ├── routes # Route definitions
│ │ ├── servies # Service implementations
│ │ └── index.js # Application settings
│ ├── bootstrap # App configurations
│ │ ├── app.js # Bootstrap application
│ │ └── autoload.js # Auto-load scripts
│ ├── config # Application configurations
│ │ ├── env # Environment variable definitions
│ │ ├── index.js # Export configurations
│ │ └── config.js # Configuration variables definitions
│ ├── database # Database settings
│ │ └── index.js # MongoDB connection settings
│ ├── lib # Third-party libraries
│ │ └── logger.js # Winston logger settings
│ └── index.js # Export application
└── test # testing scripts
```
## License
MIT © [Chun-Kai Wang](https://github.com/chunkai1312)
[travis-image]: https://img.shields.io/travis/punwave/punserve.svg
[travis-url]: https://travis-ci.org/punwave/punserve
[codecov-image]: https://img.shields.io/codecov/c/github/punwave/punserve.svg
[codecov-url]: https://codecov.io/gh/punwave/punserve
[standardjs-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg
[standardjs-url]: http://standardjs.com/