Skip to content

Code4PuertoRico/safeplaces-frontend

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Safeplaces frontend

The application is a offline-first PWA. All the functionality should be available without having an API so no data is getting shared until you push to an API.

Technology used

  • react.js
  • redux (redux-persist with localStorage to store all data on the device, redux-saga)
  • mapbox.gl
  • css modules with scss
  • jest for testing

Structure

  • use ducks scheme for redux implementation

Workflow

Roadmap

  • implement all features from the MVP-version
  • specs for API
  • specs for JSON file
  • calendar

This project was bootstrapped with Create React App.

Install

clone the repository using the dev_react branch

Copy the .env.template file in the parent directory and rename it to .env file in the parent directory. In order to make the application work correctly you have to enter API keys for Mapbox and Google places. If you don't want to register new ones feel free to ask for working credentials in the Slack channel.

REACT_APP_GOOGLE_PLACES_KEY=GOOGLE_API_KEY_WITH_PLACES_ENABLED
REACT_APP_GOOGLE_PLACES_LANGUAGE=en
REACT_APP_MAPBOX_KEY=MAPBOX_API_KEY

Available Scripts

In the project directory, you can run:

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

yarn test

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

yarn 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!

See the section about deployment for more information.

yarn eject

Note: this is a one-way operation. Once you eject, you can’t go back!

If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 61.5%
  • CSS 15.8%
  • HTML 13.2%
  • Python 8.8%
  • Other 0.7%