Get ready to invade your spaces!
- Clone the repository
- To get a faster setup create a new account on mlab.com add a new database and usename for that database
- Be sure to add a config.json file inside the config folder with your database details and at least one space (very important!) example:
{
"uname": "yourUserName",
"pwd": "yourPassword",
"dbinstance": "@dsxxxxx.mlab.com:xxxxx/databasename",
"spaces": ["Lounge",
"Conference room"
]
}
- run
npm install
- run
npm start
ornpm run devstart
(To use nodemon instead of node) - go to http://localhost:3000
- you can also go to http://localhost:3000/api/setupInvasions to create some example records on the backend
Api documentation has been added to this project using http://apidocjs.com to see the documentation just go to http://localhost:3000/doc.
In order to change the documentation, you will need to install apidoc first npm install -g apidoc
and then inside your project's folder
run apidoc -i controllers/