This is an Open Source project, which allows you to access all the code that is used to build the app and perform the analysis.
We keep the code for this app in a Github repository. This allows folks to contribute, track work, and backtrack changes (if need be) without having to maintain everything ourselves. The repository is publically accessible so you don't need any permissions to access or download it.
If you plan on using the code itself, set up a github account.
Now that you have the code, how do you run it on your machine?
The app requires python 3.6 or higher. Check what version python you have on your machine using your command prompt tool.
FYI, Macs come with python 2.7 installed. If you run python --version you may get 2.7 even if you have newer versions installed. Here's how to manage python on your Mac.
Let's fast track you. In order to avoid installing every package used by the app, you can use pipenv.
First, install pipenv.
Here's a guide to walking through that process.
We have also "containerized" the app, which means the app can run with a tool called Docker without you needing to install anything (other than docker) on your machine.
The benefit of using Docker is keeping your python environment clean. Python is a tricky tool to manage on your local machine and most python-based applications require python packages. Docker installs these packages in the container and then builds and runs the container on your machine.
Here's a basic installation guide for docker.
For guidance on running the app on your own machine please see Getting Started: Run Locally.
It is likely that we will be making changes to the app! If you want to keep your version in line with ours, you will need to sync your fork.
Git is a tool for version control. Version Control is how developers track changes in a codebase over time.
You can download the repo to your machine using the github UI :
or by running git clone https://github.com/CodeForPhilly/chime.git
in your command prompt tool.
If you plan to make changes to the code, you will want to fork the repository into your own repo. Here is a quick guide on forking.
If you are making changes, fork the repository first and then download!
If you want to host your modified app somewhere, check out Quickly Build and Deploy a Dashboard. This guide shows you how to deploy the app to a service called Heroku.