ruihildt/sleep-tracker-backend
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Add server demo link

Browse Source
This commit is contained in:
ruihildt 2019-08-01 22:38:07 +02:00
parent 0c70ee8771
commit 7bddb9a54e
2 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@ -16,12 +16,15 @@ Sleep Tracker is intended for anyone interested in improving their sleep and hea
- Make recommendations not only based on sleep time, but also on bed time (some reasearch will need to be done in that area) - Make recommendations not only based on sleep time, but also on bed time (some reasearch will need to be done in that area)
- Connect to third party sleep tracking services - Connect to third party sleep tracking services
> Server demo: https://sleep-tracker-rui.herokuapp.com/
## API Documentation ## API Documentation
___ ___
> Values required in **`bold`**. > Values required in **`bold`**.
> All requests need to provide with a JSON Web Token for authentication, except for **`/api/auth/register`** and **`/api/auth/login`**. > All requests need to provide with a JSON Web Token for authentication, except for **`/api/auth/register`** and **`/api/auth/login`**.
### USERS SCHEMA | **`users`** ### USERS SCHEMA | **`users`**
| field | data type | metadata | | field | data type | metadata |
| :--------| :---------------- | :-------------------------------------------------- | | :--------| :---------------- | :-------------------------------------------------- |

3
index.js
View File

@ -3,7 +3,8 @@ const server = require("./api/server");
server.get("/", (req, res) => { server.get("/", (req, res) => {
res.json({ res.json({
message: `API server for Sleep Tracker running. :)` message: `API server for Sleep Tracker up and running. :)`,
documentation: `https://github.com/ruihildt/sleep-tracker-backend#api-documentation`
}); });
}); });