A brewing app for iOS and Android, built with Ionic Framework.
- npm install -g karma-cli
- Clone this repository
git clone [email protected]:OpenBrews/OpenBrews.git
cd
into the repository folder.- Clone the repo's submodules
git submodule update --init --recursive
- Install the remaining dependencies with
npm install
. - Finally, you can run the app via
gulp && ionic serve [--lab]
.
- First, follow the steps above to run the app locally.
- Download the Ionic View App on your mobile device.
- Create an Ionic View account.
cd
into the repository folder- Run
ionic upload
. You will be prompted for your ionic view credentials.- If you receive an error such as
www.zip cannot be found
, press Ctrl+c to stop the process. Runmv openbrews.zip www.zip
, and runionic upload
again.
- If you receive an error such as
- First, follow the steps to run the app locally, making sure your modules are up-to-date.
- Install the Testing prereqs above.
cd
into theopenbrews/
directory.- Run
karma start
If you would like to use features which utilize the brewerydb API,
please create an account and get your own API key
here. This should be added to
your openbrews/config.json
file. If you do not have a config.json
file,
copy and rename openbrews/example.config.json
.
Note: To make requests to the BreweryDB API in the browser you will need to allow CORS in the browser you are using.
Please, don't be afraid to ask for an invite to our slack chat. We can discuss problems and work through issues together. Email Mike for an invite.
This app is built using Ionic Framework, which is built on AngularJS. If you have no idea what Ionic is, and only know AngularJS, you'll probably be fine. We are also leveraging Ionic CSS (rather than Bootstrap). Other than that, the project uses GULP, Bower, and SCSS.
Monitor the Issues board for tasks that need to be completed. Check the comments on an issue to get all the background info and see if anyone else has started work on it. When you're ready to develop, fork the repository, do your work, and submit a PR. Please note that changes may be requested. If you become a regular contributor, I may add you as a collaborator to this repository.
We are currently trying to work through our remaining issues so that we can build an Android package for an Alpha Release. We need to elicit feedback from the community as early as possible. There are about 50 people signed up to be notified when we release this.
Release 1 will focus on delivering a core Recipe Builder app. It will be a standalone application, except for some data-gathering API calls to BreweryDB.
Down the line, I would like to have an Web App and an API that allows persistance of recipes across devices, public sharing of recipes, and more!
Email Mike with any questions or concerns you may have regarding this project.
Remember, if you like what we're doing here, please star this repository :)