steve
/
mybuddy
mirror of https://github.com/snachodog/mybuddy.git
1
0
Fork 0
Code Issues 3 Packages Projects 1 Releases Wiki Activity

Update README.

This commit is contained in:
Christopher Charbonneau Wells 2017-10-23 20:33:28 -04:00
parent 8daf82ffa0
commit d293fd7740
1 changed files with 23 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -5,7 +5,7 @@
[![License](https://img.shields.io/badge/License-BSD%202--Clause-orange.svg)](https://opensource.org/licenses/BSD-2-Clause) [![License](https://img.shields.io/badge/License-BSD%202--Clause-orange.svg)](https://opensource.org/licenses/BSD-2-Clause)
A buddy for babies! Helps caregivers track sleep, feedings, diaper changes, and A buddy for babies! Helps caregivers track sleep, feedings, diaper changes, and
tummy time to learn about and predict baby's needs without (as much) guess tummy time to learn about and predict baby's needs without (*as much*) guess
work. work.
![Baby Buddy](screenshot.png) ![Baby Buddy](screenshot.png)
@ -18,6 +18,17 @@ The demo instance resets every hour. Login credentials are:
- Username: `admin` - Username: `admin`
- Password: `admin` - Password: `admin`
## Deployment
**:warning: Baby Buddy is still in early development and does not yet have a
stable production deployment flow. :warning:**
### Heroku
[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)
Once the app is deployed, log in with the default credentials (`admin`/`admin`).
## Development ## Development
### Installation ### Installation
@ -41,3 +52,13 @@ From within the pipenv shell, execute:
``` ```
python manage.py fake python manage.py fake
``` ```
### Testing
:exclamation: Tests require static files to be collected, it may be necessary
to execute ``gulp build && gulp collectstatic`` before tests (if static files
have changed).
```
gulp test
```