generator-api

Yeoman generator for creating RESTful NodeJS APIs, using ES6, Mongoose and Express. The fastest way to get your project up and running using an awesome stack.

Getting started

Make sure you have yeoman installed on your machine: npm install -g yo
Install the generator globally: npm install -g generator-api
Run: yo api, or yo and choose Api option

Running the generated project

Make sure you have node version >= 6.3 because this project uses es6 features without compiling with babel.

Run: mongod to start the local mongodb instance. If you don't have mongodb installed locally, visit their webpage
Run: npm run dev to start the local server with nodemon at localhost:8080

To do

Add to README how is the project's architecture, and tips on how to scale from the generated project
Give the generator more startup options
Create more generator templates to add new controllers / models / schemas once the project was initialized
Implement testing in the generated project

Contributing

Contributors are welcome, please fork and send pull requests! If you have any ideas on how to improve this project please submit an issue.

License