Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kylealwyn/node-rest-api-boilerplate
ES6 Node Rest API boilerplate with Mongo Datastore
https://github.com/kylealwyn/node-rest-api-boilerplate
boilerplate es6 mongo node
Last synced: 4 months ago
JSON representation
ES6 Node Rest API boilerplate with Mongo Datastore
- Host: GitHub
- URL: https://github.com/kylealwyn/node-rest-api-boilerplate
- Owner: kylealwyn
- License: mit
- Created: 2016-10-24T23:44:42.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2020-08-20T14:58:30.000Z (over 4 years ago)
- Last Synced: 2024-10-08T11:07:21.924Z (4 months ago)
- Topics: boilerplate, es6, mongo, node
- Language: JavaScript
- Homepage:
- Size: 187 KB
- Stars: 105
- Watchers: 12
- Forks: 40
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: History.md
- License: LICENSE
Awesome Lists containing this project
README
# Express & ES6 API Boilerplate
[](https://travis-ci.org/kylealwyn/node-rest-api-boilerplate)
> Tested on Node v6 and above
## Features
- [x] ES6 for the latest & greatest javascript awesomeness
- [x] [MongoDB](https://www.mongodb.com/) w/ [Mongoose](http://mongoosejs.com/) for data layer
- [x] Testing via [Mocha](https://mochajs.org/) & [Chai](http://chaijs.com/)
- [x] Test coverage via [Isparta](https://github.com/douglasduteil/isparta)
- [x] Username/Email registration and authentication
## Getting Started
First, ensure you have node and mongo installed on your system.
```sh
# clone it
git clone [email protected]:kylealwyn/node-rest-api-boilerplate.git
cd node-rest-api-boilerplate
# Make it your own
rm -rf .git && git init
# Install dependencies
npm install
# Run it
npm start
# Try it!
curl -H "Content-Type: application/json" -X POST -d '{"username":"jamesdean", "email": "[email protected]", "password":"password1"}' http://localhost:4567/users
```
## Environment Variables
Place a `.env` file in the top level of the directory you've cloned. These variables will be automatically assigned to `process.env` when the application boots. It is gitignored by default as it's not good practice to store your environment variables in your remote repository.
Your `.env` file can look something like this:
```shell
MONGO_URI=mongodb://somewhere:27017
SESSION_SECRET=lolthisissecret
```
Now we can access one of these variables with something like `process.env.MONGO_URI`!
## NPM Scripts
- **`npm start`** - Start live-reloading development server
- **`npm test`** - Run test suite
- **`npm run test:watch`** - Run test suite with auto-reloading
- **`npm run coverage`** - Generate test coverage
- **`npm run build`** - Generate production ready application in `./build`
## Todo
- [ ] Add OAuth Login Support (Facebook, Twitter, Google)
- [ ] Add support for MySql or PostgreSQL (Possibly with sequelize)
- [ ] Reset password functionality
## License
MIT