Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tutts/es6-express-mongoose-passport-rest-api
Lightweight boilerplate for Node RESTful API, ES6, Express, Mongoose and Passport 🎁
https://github.com/tutts/es6-express-mongoose-passport-rest-api
api boilerplate es6 express javascript mongoose node passport restful
Last synced: 3 months ago
JSON representation
Lightweight boilerplate for Node RESTful API, ES6, Express, Mongoose and Passport 🎁
- Host: GitHub
- URL: https://github.com/tutts/es6-express-mongoose-passport-rest-api
- Owner: tutts
- Created: 2017-03-13T21:25:47.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2017-10-03T10:55:46.000Z (over 7 years ago)
- Last Synced: 2024-11-16T01:10:57.574Z (3 months ago)
- Topics: api, boilerplate, es6, express, javascript, mongoose, node, passport, restful
- Language: JavaScript
- Homepage:
- Size: 63.5 KB
- Stars: 35
- Watchers: 2
- Forks: 8
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Node boilerplate
This is my node boilerplate starter kit. I will continue to update with the latest tech to help make make node services
super easy and efficient to kick start.
## Whats out the box?
### Frameworks
- Node 7 + ES6 (Babel)
- Express
- Passport
- Mongoose
- Joi
### Developer tools
- Jest
- Docker
- Husky (Githooks)
## Instructions
Install [mongodb](https://www.mongodb.com/download-center?jmp=nav#community) and fire up the server
```
mongod
```
Install [`yarn`](https://www.npmjs.com/package/yarn). Not used yarn yet? Do its awesome... and required
```
npm install -g yarn
```
Pull down the repository
```
git clone https://github.com/tutts/node-es6-express-mongoose-passport
```
Run yarn in the root of your project to install its dependencies
```
yarn
```
### Server
Start in development mode http://localhost:4040/health-check
```
yarn dev
```
Build the distributable
```
yarn build
```
Build the distributable + start node server http://localhost:8080/health-check
```
yarn start
```
### Tests
Run tests or code coverage in Jest
```
yarn test
yarn test:coverage
```
Running lint **(deprecated)**
** ESLint has now been removed in favour of Prettier. As of version 1.0.0, semi colons are now optional and disabled as
default. **
```
yarn lint
yarn lint:watch
yarn lint:fix // attempts to fix your lint issues for you
```
## Todo
- [ ] add dotenv
Inspired by [KunalKapadia](https://github.com/KunalKapadia/express-mongoose-es6-rest-api) and [Developit](https://github.com/developit/express-es6-rest-api)