Add Nanobox info to README.

This commit is contained in:
Christopher Charbonneau Wells 2017-11-15 13:08:13 -05:00
parent 979f352580
commit d877d36646
1 changed files with 51 additions and 15 deletions

View File

@ -12,6 +12,17 @@ work.
![Baby Buddy mobile views](screenshot_mobile.png)
**Table of Contents**
- [Demo](#demo)
- [Deployment](#deployment)
- [Heroku](#heroku)
- [Nanobox](#nanobox)
- [Development](#development)
- [Installation](#installation)
- [Fake data](#fake-data)
- [Testing](#testing)
## Demo
A [demo of Baby Buddy](https://babybuddy.herokuapp.com) is available on Heroku.
@ -25,24 +36,53 @@ The demo instance resets every hour. Login credentials are:
**:warning: Baby Buddy is still in early development and does not yet have a
stable production deployment flow. :warning:**
The default user name and password for Baby Buddy is `admin`/`admin`. For any
deployment, **log in and change the default password immediately**.
### 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`).
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>
### Nanobox
An example [Nanobox](https://nanobox.io/) 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](https://guides.nanobox.io/python/django/)
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
1. Enter the cloned/downloaded directory
cd babybuddy
1. 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>
1. Deploy! :rocket:
nanobox deploy
## Development
### Installation
```
pip install pipenv
pipenv install --dev
npm install -g gulp-cli
npm install
gulp migrate
gulp
```
pip install pipenv
pipenv install --dev
npm install -g gulp-cli
npm install
gulp migrate
gulp
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`).
@ -51,9 +91,7 @@ user name and password (`admin`/`admin`).
Add some fake data to the database with the following command:
```
gulp fake
```
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.
@ -66,6 +104,4 @@ days of data for each.
to execute ``gulp build && gulp collectstatic`` before tests (if static files
have changed).
```
gulp test
```
gulp test