README.md

Baby Buddy

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 work.

Table of Contents

• Demo
• Deployment
  • AWS Elastic Beanstalk
  • Nanobox
  • Heroku
• Development
  • Installation
  • Fake data
  • Testing

Demo

A demo of Baby Buddy is available on Heroku. The demo instance resets every hour. Login credentials are:

• Username: admin
• Password: admin

Deployment

⚠️ Baby Buddy is still in early development and does not yet have a stable production deployment flow. ⚠️

The default user name and password for Baby Buddy is admin/admin. For any deployment, log in and change the default password immediately.

AWS Elastic Beanstalk

A basic Elastic Beanstalk configuration is provided in .ebextensions\babybuddy.config. The steps below are a rough guide to deployment. See Working with Python for detailed information.

1. Clone/download the Baby Buddy repo

    git clone https://github.com/cdubz/babybuddy.git
   

2. Enter the cloned/downloaded directory

    cd babybuddy
   

3. Change the SECREY_KEY value to something random in .ebextensions\babybuddy.config

4. Create an IAM user in AWS with EB, EC2, RDS and S3 privileges.

5. Initialize the Elastic Bean application (using the IAM user from the previous step)

    eb init
   

6. Create/deploy the environment! 🚀

    eb create -db -db.engine postgres
   

The create command will also do an initial deployment. Run eb deploy to redeploy the app (e.g. if there are errors or settings are changed).

Nanobox

An example Nanobox configuration, boxfile.yml, is provided with Baby Buddy. The steps below are a rough guide to deployment. See Create and Deploy a Custom Django App for detailed information about Nanobox's deployment and configuration process.

1. Clone/download the Baby Buddy repo

    git clone https://github.com/cdubz/babybuddy.git
   

2. Enter the cloned/downloaded directory

    cd babybuddy
   

3. Add the SECREY_KEY and DJANGO_SETTINGS_MODULE environment variables

    nanobox evar add DJANGO_SETTINGS_MODULE=babybuddy.settings.nanobox
    nanobox evar add SECRET_KEY=<CHANGE TO SOMETHING RANDOM>
   

4. Deploy! 🚀

    nanobox deploy
   

Heroku

For manual deployments to Heroku without using the deploy button, make sure to create two settings before pushing using heroku config:set:

heroku config:set DJANGO_SETTINGS_MODULE=babybuddy.settings.heroku
heroku config:set SECRET_KEY=<CHANGE TO SOMETHING RANDOM>

Development

Installation

pip install pipenv
pipenv install --dev
npm install -g gulp-cli
npm install
gulp migrate
gulp

Open http://127.0.0.1:8000 and log in with the default user name and password (admin/admin).

Fake data

Add some fake data to the database with the following command:

gulp fake

By default, fake creates one child and 31 days of random data. Use the --children and --days flags to change the default values, e.g. gulp fake --children 5 --days 7 to generate five fake children and seven days of data for each.

Testing

❗ 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