0.0.1 • Published 8 years ago
admin_site v0.0.1
Admin Site for MicroSite 🖖
Before you start
Before you start with this project, please ensure that you have swagger modules installed. You may do it by visiting here
Steps to get up and running
- Make sure you have swagger installed globally by typing
npm install -g swagger
. You may need to addsudo
on *nix box - Clone this repo (duh!)
- Run npm install to pull all dependencies and setup environment.
- Copy
config
fromnode_modules
tonode_modules/swagger-express-mw/node_modules/swagger-node-runner/node_modules
. - Run
bower install
from /public - Type
npm start
to start the project. - Install ESLint by typing
npm install eslint -g
. You may need to installnpm install through -g
- To Debug - Install node-inspector by typing
npm install -g node-inspector
and then typenode-debug app.js
to run app in debug mode
Making changes
If you need to change any API, please execute the following :
swagger-project edit .
from the Code root directory
- Controllers are located at
/api/controllers
- Helpers and utilites are located at
/api/helpers
- Models for Mongo will be located at
/api/models
#Misc Notes
- I recommed using Visual Studio Code with eslint integration. This ensures consistency in coding standards.
0.0.1
8 years ago