Demo App. Create your own account or use this demo account: Username [email protected], Password password1
We are developing a tool for the communities of Chelsea, Revere, Saugus, and Winthrop to improve multi-sector and multi-jurisdictional coordination for outreach, response, and recovery to overdoses. We will do this by improving the efficiency of existing systems, speeding up access to critical data, and aiding in cross-jurisdictional communication, in order to help these four communities save lives.
Our partner in the project is the City of Revere Substance Use Disorder Initiatives (SUDI) office. They are working with three other communities – Chelsea, Saugus and Winthrop – on fulfilling a newly-provided grant to scale up their existing overdose response outreach programs. The project that we create will ultimately take into account the workflows of all four communities and would be shared amongst them to meet all of their needs.
The SUDI office offers support and resources as well as ongoing care in these communities via direct outreach with individuals who have experienced a nonfatal overdose.
Trello Team Invitation - This holds all of our trello boards and will allow you access to the boards below
Trello Sprint Board - This tracks work items
Trello Roadmap Board - This holds our long-term planning info
- Join us on Slack at #harm-reduction
- Join our Trello team
- Request access to our Google Drive Folder (instructions here)
- Jump into our Google Meet Room and hang out with us!
If you don't have nodejs installed, install it. If you don't know, do node --version in your terminal/command prompt. If you don't get a number, you don't have it.
If you're new to github check out Github Guide, Hello World to make an account and get started with Github and How to: fork a repo to learn how to fork a repo.
- Fork the repository: On GitHub, navigate to the repository. In the top-right corner of the page, click Fork.
- On GitHub, navigate to your fork of the harm-reduction repository. In the Clone with HTTPs section, click to copy the clone URL for the repository.
- Clone your fork: In your terminal type
git clone, paste the URL you copied and press enter. In your terminal/command prompt cd (change directory) into the new folder. Inside the directory:
git clone \
https://github.com/YOUR-USERNAME/harm-reduction.git
cd harm-reduction
- Add the harm-reduction repository as a remote to your fork and fetch its branch information:
git remote add upstream \
https://github.com/codeforboston/harm-reduction.git
git fetch upstream
- Install dependencies
npm install
- (Optional) Enable pre-push Git hooks. This will lint and test your code when you run
git push. It is useful to catch errors early, before code review. If you doin't feel comfortable fixing broken tests, you should skip this step. In your.bashrcor.bash_profile, add this line:
export RUN_HARM_REDUCTION_GIT_HOOKS=1
-
In your terminal/command prompt run
npm startto start the app. It will open automatically in a browser window. -
To stop the local server press ctrl + c in your terminal
To contribute a feature:
- Claim a card in the Todo column on Trello
- Create a feature branch in your fork. Here we call it MY-FEATURE, but you should name your branch after the feature you're implementing, like participants-table
git checkout main
git checkout -b MY-FEATURE
git push --set-upstream origin MY-FEATURE
- Make your changes in your feature branch
- Upload your changes to your fork
git push origin MY-FEATURE
- Open a pull request to merge your feature branch into codeforboston's main branch. Link to the Trello card in your PR description.
- Respond to comments in the pull request conversation
- Once all checks pass and someone approves, merge the pull request!
To learn more about keeping your fork up to date view this article. When there is an update, in your terminal inside your local repo:
git checkout main
git pull upstream main
This will update your fork's main branch to match upstream. Then, to update your feature branch, run:
git checkout MY-FEATURE
git merge main
If there is a merge conflict that cannot be resolved automatically, the output from the git pull command will read: "Automatic merge has failed; fix conflicts and then commit the result." For more information, read this article.
REMEMBER: After pulling in updates and resolving any merge conflicts, run the following in terminal, which will install any new dependencies:
npm install
We use Jest for DOM and unit tests. Run npm test to get started. Tests run automatically when a pull request is opened.
We use Travis for automated testing and deployment.
Tests run on all branches and for pull requests. On main, after tests pass, we deploy the site using Firebase.
The main Firebase project, where the demo is hosted, is cfb-harm-reduction. cfb-harm-reduction-dev is used for development. Both use the Spark plan, which enforces free limits on usage.
The deployment is configured with environment variables set in Travis settings:
FIREBASE_PROJECT: The name of the firebase project to deploy to.FIREBASE_TOKEN: The token used to authenticate with Firebase, generated byfirebase login:ci. The user that generates the token must have permission to deploy to the firebase project.