Skip to content

Latest commit

 

History

History
76 lines (53 loc) · 5.82 KB

README.md

File metadata and controls

76 lines (53 loc) · 5.82 KB
Raw

Community Connect

"Community Connect" is a health resource web application that aims to consolidate information about businesses and organization available in communities that promote healthy lifestyle choices. A health resource is defined as services or materials that improve the quality of life of others, ranging from affordable child care, substance abuse counseling, domestic violence support, and more. We are working in conjunction with Massachusetts General Hospital's Center for Community Health Improvement, MGH Revere HealthCare Center, and Revere CARES Coalition to create an extensive database in our pilot region of Revere, Chelsea, Charlestown, and eventually the Greater Boston Area.

To suggest businesses and/or organizations in the area that are not presently listed, please visit: https://goo.gl/forms/X2Nou8ZLtrmz0JGe2

  1. Stage 1 - Simple Name Search, Category Filter, Semi-clickable List, Map with Pins.
  2. Stage 2 - Fuzzy search, Mobile Compatibility, organized card with all relevant information about selected resource on Map, import and maintain up-to-date information about resources, unique URL created for specified Org Cards.
  3. Stage 3 - Make improvements based on feedback from Social Workers at the Revere HealthCare Center, make the codebase more transferrable for other projects that use a spreadsheet and website that reflects that data.

How this works

Resources are stored in a google spreadsheet (New). https://docs.google.com/spreadsheets/d/1QolGVE4wVWSKdiWeMaprQGVI6MsjuLZXM5XQ6mTtONA/edit?usp=sharing

The spreadsheet automatically publishes its contents to a json endpoint that this app consumes. Members of the community can add unvetted resources to the spreadsheet via a google form. Trusted members with access to the spreadsheet will vet submitted resources & mark them as vetted. The app will only display vetted resources.

Note that this project was bootstrapped with Create React App. Create React App gives us lots of functionality not documented in this readme.

New Developer Setup Instructions

  1. clone the repo
  2. install yarn (it may be installed already)
  3. install dependencies yarn install
  4. start server yarn start

Where to start

Our open issues are listed on the project's Issues tab. The best places to start are unassigned issues with the label "good first issue". Those with "bug" and "help wanted" are great too, but may require more experience. Avoid issues labeled "epic" until you're more familiar with the project.

A great first issue to look into doing is the React warnings that can be found in the developer console. To solve a React warning there is no need to create a issue. Just make an announcement in Slack that you are going to work on which ever specific warnings. Then put together a pull request with the code changes.

Beginner resources

http://freecodecamp.com/

https://www.codecademy.com/

https://github.com/firstcontributions/first-contributions

Connect with the team

Join our Code for Boston slack channel: #community-connect or look for us at the CfB Tuesday meet-ups.

Want your own spreadsheet?

Prefer to see a gif of this process instead of reading steps? Click here

  1. Visit the current spreadsheet
  2. Click File and select Make a Copy
  3. Click OK
  4. When viewing your copy, click SHARE in the upper-right hand corner.
  5. Click "Get shareable link" in the upper-right hand corner of the modal.
  6. Ensure that "Anyone with the link can view" is selected.
  7. Copy link
  8. Click done
  9. Click File and select "Publish to the web"
  10. Click Publish
  11. Open "src/App.js" in the codebase
  12. Replace "revere_key" with a portion of the URL in your clipboard

Example: https://docs.google.com/spreadsheets/d/1FRd8Jw7y4CnnHCKIvkM-pjNjRVFHFHuobVU-ajXre6M/edit?usp=sharing

Replace the "revere_key" value with "1FRd8Jw7y4CnnHCKIvkM-pjNjRVFHFHuobVU-ajXre6M"

Start your server using yarn start

Why would I want my own spreadsheet?

  1. Some features may require you to modify the data to validate your code.
  2. The production spreadsheet should not be modified for testing purposes.

Editor setup

Syntax highlighting To configure the syntax highlighting in your favorite text editor, head to the relevant Babel documentation page and follow the instructions. Some of the most popular editors are covered.

Ignore generated files Your editor will search all the files in the project - including large generated ones & dependencies unless you tell it not to. Look into how your editor can ignore node_modules/* and build/*

History

The original architectural design for this app was designed proven out by Bob Breznak for an organization assisting with the refugee crisis in Greece in 2016, Prosper. They needed help consolidating, vetting and displaying resources on the web. In May 2018 he re-wrote the frontend in react.js to create an app that assists homeless people Seeking Shelter and resources. In August 2018 Code for Boston’s Community Connect project had similar aims and the repo was moved into their org. The data used for this project was initially collected from Nevil Desai during his internship with Revere CARES, a coalition group under the umbrella of MGH Center for Community Health Improvement.