b38a258940 | ||
---|---|---|
controllers | ||
models | ||
.eslintrc.json | ||
.gitignore | ||
LICENSE | ||
README.md | ||
apiRoutes.js | ||
architecture.png | ||
config.json | ||
logger.js | ||
package-lock.json | ||
package.json | ||
server.js |
README.md
trackmyd-api
A simple REST API for trackmyd.
Architecture
Paths & Operations
Path | Operation | Description |
---|---|---|
/devices | GET | Get devices |
/devices | POST | Add new device |
/devices?id= | GET | Get single device |
/devices?id= | PATCH | Update device |
/device?id= | DELETE | Delete device |
/device?name= | GET | Get single device |
Installation
Step by step
- Install NodeJS and NPM.
- Install Mongodb.
- Clone this repository.
- Install dependencies with
npm install
. - Configure users (app.auth.users) basic authentication into
config.json
. - Configure database (db) into
config.json
. - Start with
npm start
.
Made with ❤️ by Francesco Esposito (@franjsco)