Skip to content

canadianveggie/astrid

Repository files navigation

ASTRID - Analytic System Tracking Rapid Infant Development

A charting and visualization webapp that takes exported Feed Baby data and makes it easier to understand.

Getting Started

This projected is designed to be easily forked to include your own baby's data. The master branch is just code. All of the data lives on the gh-pages branch in the _data directory.

Hosting on Github Pages

ASTRID is designed to be hosted on Github Pages, which uses Jekyll as its web engine.

Just go to Settings -> Github Pages

and choose the gh-pages branch as the Source.

Running locally

If you want to run ASTRID locally, you will need node.js and Ruby 2.1 or higher installed.

The Gemfile contains local Jekyll dependencies. Use bundle to install them.

gem install bundle
bundle update && bundle install

The package.json file includes developer tools (like grunt). Use yarn to install them.

yarn install

To start the local webserver:

yarn start

Then open http://127.0.0.1:4000/ in your browser.

Adding your own data

To update your Feed Baby data, export the latest zipfile of CSV data and extract it into the _data directory.

Other data that can be specified includes:

Metadata in baby.yml

name:
gender:  # male or female
birthdate: # format YYYY-MM-DD
picture_url:

Milestones in milestones.csv (which will create a photo carousel)

date,title,description,photo

Adding new features

3rd party javascript libraries can easily be added with bower. Because of how Jekyll works, the main files will needed to be checked into the vendor directory. Grunt will automatically install the bower components and copy the main files into vendor. For example:

bower install underscore --save
grunt
git add vendor/underscore

About

Analytic System Tracking Rapid Infant Development

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published