From d293fd774072e73bbeb161a30425fd7a0fe4111d Mon Sep 17 00:00:00 2001 From: Christopher Charbonneau Wells Date: Mon, 23 Oct 2017 20:33:28 -0400 Subject: [PATCH] Update README. --- README.md | 25 +++++++++++++++++++++++-- 1 file changed, 23 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index fa9d50b3..878abcda 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ [![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 -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. ![Baby Buddy](screenshot.png) @@ -18,6 +18,17 @@ The demo instance resets every hour. Login credentials are: - Username: `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 ### Installation @@ -40,4 +51,14 @@ From within the pipenv shell, execute: ``` python manage.py fake -``` \ No newline at end of file +``` + +### 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 +```