swang75 / streetlives-web

The Streetlives web app

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Streetlives Web

Streetlives is a community-built platform for enabling people who are homeless or in poverty to easily find, rate and recommend social services across New York City.

This repository contains the Streetlives web application, which provides an interface for accessing and interacting with the Streetlives data.

The app consists of several parts (some may be split into their own apps/repos in the future):

  • GoGetta - the first, experimental version of the main user-facing app. Can be used to find services, but not yet to rate them nor provide extensive feedback

  • The Streetlives Street Team Tool (SSTT), which allows trusted users to update and create data about services

  • A comment-gathering tool, used in a pilot with a few service providers in NY looking to gather feedback from their users

This project was bootstrapped with Create React App. You will find more information on how to perform tasks in the most recent version of their guide here.

Installing

  1. Clone the repo:
$ git clone git@github.com:streetlives/streetlives-web.git
  1. Install the dependencies:
$ cd streetlives-web
$ npm install

Getting Started

In the project directory, you can run:

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

npm run deploy

Deploys the app to the S3 bucket currently used for production.

Should only be done after first running REACT_APP_API_URL="<API URL>" npm run build, with "API URL" as the API Gateway URL exposing the Streetlives API in production.

Also, the AWS CLI must be set up for this script to run successfully.

License

This project is licensed under the MIT License - see the LICENSE file for details.

About

The Streetlives web app


Languages

Language:JavaScript 92.2%Language:CSS 7.1%Language:HTML 0.7%