arrow-left

All pages
gitbookPowered by GitBook
1 of 5

Loading...

Loading...

Loading...

Loading...

Loading...

Hosting the App

If you want to host your modified app somewhere, check out . This guide shows you how to deploy the app to a service called .

Quickly Build and Deploy a Dashboardarrow-up-right
Herokuarrow-up-right

Maintaining the App

hashtag
Sync your fork

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 forkarrow-up-right

Building the App Locally

Now that you have the code, how do you run it on your machine?

hashtag
Running in Python

The app requires python 3.6 or higher. Check what version python you havearrow-up-right 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 Macarrow-up-right.

hashtag
Create your python environment

Let's fast track you. In order to avoid installing every package used by the app, you can use pipenv.

First, pipenv.

's a guide to walking through that process.

hashtag
Running in Docker

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 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.

For guidance on running the app on your own machine please see .

installarrow-up-right
Herearrow-up-right
tricky tool to managearrow-up-right
Here's a basic installation guide for docker.arrow-up-right
Getting Started: Run Locallyarrow-up-right

Making a Repo

Git is a tool for version control. Version Control is how developers track changes in a codebase over time.

hashtag
Downloading the files

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.

hashtag
Keeping your changes

If you plan to make changes to the code, you will want to fork the repository into your own repo. is a quick guide on forking.

If you are making changes, fork the repository first and then download!

Herearrow-up-right

Making your own CHIME app

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.

hashtag
Git

We keep the code for this app in a Github repositoryarrow-up-right. 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 accountarrow-up-right.

hashtag