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

Update readme intro and formatting

Browse Source
This commit is contained in:
ruihildt 2019-07-29 18:37:09 +02:00
parent f6b7212199
commit 3bb86c6198
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -1,6 +1,6 @@
Sleep Tracker allows Users to create an account and track their sleep and mood every day in order to improve their sleep. Sleep Tracker helps Users track their sleep and mood every day.
It gives Users a better idea of their sleep pattern and improve their health.
After one month, Sleep Tracker will give recommendation of optimal sleep duration. After one month, Sleep Tracker will give recommendation of optimal sleep duration.
Sleep Track aims to help Users improve their sleep pattern and global health.
## Target Audience ## Target Audience
Sleep Tracker is intended for anyone interested in improving their sleep and health. Sleep Tracker is intended for anyone interested in improving their sleep and health.
@ -26,23 +26,23 @@ Sleep Tracker is intended for anyone interested in improving their sleep and hea
| username | string | required | | username | string | required |
| password | string | required | | password | string | required |
### Sleep Sessions | `sessions` ### Sleep Sessions `sessions`
| field | data type | metadata | | field | data type | metadata |
| :------------ | :--------------- | :-------------------------------------------------- | | :------------ | :--------------- | :-------------------------------------------------- |
| id | unsigned integer | primary key, auto-increments, generated by database | | id | unsigned integer | primary key, auto-increments, generated by database |
| user_id | unsigned integer | foreign key referencing users.id, required | | user_id | unsigned integer | foreign key referencing `users.id`, required |
| bed_time | unsigned integer | timestamp with date, required | | bed_time | unsigned integer | timestamp with date, required |
| wake_time | unsigned integer | timestamp with date, required | | wake_time | unsigned integer | timestamp with date, required |
| bed_tiredness | unsigned integer | between 1-5, | | bed_tiredness | unsigned integer | between 1-5, |
| wake_mood | unsigned integer | between 1-5, | | wake_mood | unsigned integer | between 1-5, |
| day_mood | unsigned integer | between 1-5, | | day_mood | unsigned integer | between 1-5, |
### Average Mood per Sleep Session | `moods` ### Average Mood per Sleep Session `moods`
| field | data type | metadata | | field | data type | metadata |
| :------------- | :--------------- | :--------------------------------------------------- | | :------------- | :--------------- | :--------------------------------------------------- |
| id | unsigned integer | primary key, auto-increments, generated by database | | id | unsigned integer | primary key, auto-increments, generated by database |
| session_date | unsigned integer | foreign key referencing sessions.wake_time | | session_date | unsigned integer | foreign key referencing `sessions.wake_time` |
| sleep_duration | unsigned integer | | | sleep_duration | unsigned integer | |
| average_mood | float | average of bed_tiredness/wake_mood/day_mood | | average_mood | float | average of bed_tiredness/wake_mood/day_mood |