This is meant to be a starter project to help you create a simple Node API. The design was originally based off of an older version of the MEAN stack with the goal of making it a bit simpler to pickup, understand, and begin deving.
The main feature of this project is its quick time to development for a generic RESTful backend. Vagrant creates a standard environment where all prerequesites are downloaded automatically. It also setsup a shared folder within the virtual machine which shares the project folder. Any changes made locally on the host are detected by filewatchers and the server is automatically restarted using PM2. This reduces setup time tremendously.
The second main feature of this project is its simple design. It is meant to be a very basic starting point by setting up much of the standard server work for you. This includes creating a base architecture, system for setting project variables, tests, database connections, etc. All you have to do get started is define a model in Mongoose, set routes, and then write your controller logic. So simple!
Prerequiresites: VirtualBox and Vagrant
Clone the repository and enter the project directory
start the virtual machine
$ vagrant up
SSH into the virtual machine
$ vagrant ssh
At this point the virtual machine will be up with the server and file watchers running and can be visited locally at 192.168.33.10:3000
Prerequiresites: Node.js
Clone the repository and enter the project directory
Install dependencies
$ npm install
Start the server
$ node server.js
Now the server will be hosted locally on port 3000.