franjsco
/
trackmyd-api
mirror of https://github.com/franjsco/trackmyd-api
1
0
Fork 0
Code Issues Releases Wiki Activity
32 Commits 10 Branches 1 Tag 376 KiB
JavaScript 100%
Go to file
Francesco Esposito 97f91d7178
Merge pull request #2 from frsposito/dependabot/npm_and_yarn/js-yaml-3.13.1 
Bump js-yaml from 3.12.1 to 3.13.1
 		2019-11-03 10:43:53 +01:00
controllers implements status code 404 in index 2019-02-22 10:09:38 +01:00
models remove get function 2019-02-22 10:10:24 +01:00
.eslintrc.json npm/lint init 2019-02-19 18:25:10 +01:00
.gitignore add .gitignore 2019-02-19 18:26:12 +01:00
LICENSE Initial commit 2019-02-12 23:03:53 +01:00
README.md fix readme 2019-07-23 21:05:43 +02:00
apiRoutes.js add add/find query parameters in controller/routes 2019-02-20 09:39:54 +01:00
architecture.png edit readme 2019-03-04 20:31:52 +01:00
config.json add authentication 2019-02-20 12:48:32 +01:00
logger.js add logging 2019-02-20 11:09:57 +01:00
package-lock.json Merge pull request #2 from frsposito/dependabot/npm_and_yarn/js-yaml-3.13.1 2019-11-03 10:43:53 +01:00
package.json Bump express-basic-auth from 1.1.6 to 1.1.7 2019-11-03 09:38:17 +00:00
server.js implements db events 2019-02-22 10:12:24 +01:00

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

  1. Install NodeJS and NPM.
  2. Install Mongodb.
  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.

Made with ❤️ by Francesco Esposito (@frsposito)