Tutorial: Hack on Anny

Setup

If you plan to submit your changes back to Anny, use the Contributing instructions.

Install node.js
git clone https://github.com/levithomason/anny.git
cd anny
npm install
npm start

Contributing

Use these instructions if you plan on submitting your changes to Anny.

Fork Anny to your account
git clone <your fork>
cd anny
git checkout -b <new branch>
npm install
npm start
Make changes, commit and push
Open a Pull Request with base: master and compare: <your branch>.

We'll review your PR and help you get it merged into the integration branch.

Dev Process

Once you have Anny running locally, you can use the commands below.

Run gulp then open your browser to http://localhost:8000. Make changes to Anny in /lib, the demo app in /app, or the doc site in /docs/src. The project is automatically rebuilt and the browser refreshed.

gulp                      # build, serve, and watch
gulp help                 # list gulp commands and help

npm start                 # install dependencies, build, serve, and watch
npm test                  # run tests and generate coverage
npm run                   # list npm commands

Project Structure

This repo contains two projects.

/lib Anny, the neural net library.

/app An AngularJS web app for demoing and testing purposes