mybuddy/README.md

43 lines
1.1 KiB
Markdown
Raw Normal View History

2017-10-22 20:00:29 +00:00
# Baby Buddy
2017-10-22 22:24:52 +00:00
[![Build Status](https://travis-ci.org/cdubz/babybuddy.svg?branch=master)](https://travis-ci.org/cdubz/babybuddy)
[![Coverage Status](https://coveralls.io/repos/github/cdubz/babybuddy/badge.svg?branch=master)](https://coveralls.io/github/cdubz/babybuddy?branch=master)
2017-10-23 08:25:31 +00:00
[![License](https://img.shields.io/badge/License-BSD%202--Clause-orange.svg)](https://opensource.org/licenses/BSD-2-Clause)
2017-10-22 22:24:52 +00:00
2017-10-22 21:08:16 +00:00
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.
![Baby Buddy](screenshot.png)
2017-10-22 20:00:29 +00:00
2017-10-23 09:25:56 +00:00
## Demo
A [demo of Baby Buddy](https://babybuddy.herokuapp.com) is available on Heroku.
The demo instance resets every hour. Login credentials are:
- Username: `admin`
- Password: `admin`
2017-10-23 09:25:56 +00:00
2017-10-23 08:25:31 +00:00
## Development
### Installation
2017-10-22 20:00:29 +00:00
```
pip install pipenv
pipenv install --dev
2017-10-22 21:23:48 +00:00
npm install -g gulp-cli
2017-10-22 20:00:29 +00:00
npm install
gulp migrate
gulp
2017-10-22 20:00:29 +00:00
```
Open [http://127.0.0.1:8000](http://127.0.0.1:8000) and log in with the default
user name and password (`admin`/`admin`).
2017-10-22 20:00:29 +00:00
### Fake data
From within the pipenv shell, execute:
```
python manage.py fake
```