trackmyd-api/README.md

35 lines
940 B
Markdown
Raw Permalink Normal View History

2019-03-04 20:31:52 +01:00
# trackmyd-api
2019-03-04 20:42:13 +01:00
A simple REST API for trackmyd.
2019-03-04 20:31:52 +01:00
## Architecture
2019-07-23 21:03:14 +02:00
<img src="architecture.png" height="150">
2019-03-04 20:31:52 +01:00
## Paths & Operations
2019-07-23 21:03:14 +02:00
| 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 |
2019-03-04 20:31:52 +01:00
## Installation
### Step by step
1. Install **NodeJS** and **NPM**.
2. Install **Mongodb**.
2019-07-23 21:03:14 +02:00
3. Clone this repository.
4. Install dependencies with `npm install`.
5. Configure **users** (app.auth.users) basic authentication into `config.json`.
6. Configure database (db) into `config.json`.
7. Start with `npm start`.
2019-07-23 21:05:43 +02:00
---
2020-03-01 23:39:43 +01:00
Made with ❤️ by Francesco Esposito ([@franjsco](https://github.com/franjsco))