Bridges to Prosperity is a nonprofit that helps build footbridges in east African communities. They have collected a lot of data about various villages and we need to match it to government data. Afterwards, we will create predictions and visualizations as to where are the best places for footbridges.
- Visualize Bridge Data on a Map
- Ability to filter through different bridge completion stages
- Ability to see multiple bridge completion stages at once
- Use of map clustering, enhances map performance by an icon with the amount of bridges in an area. as you zoom in the bridge point appears.
- Dashboard containing graphs, charts, and tables to visualize bridge data
Bridges to Prosperity is a nonprofit that helps build footbridges in east african communities. They have collected a lot of data about various villages and we need to match it to government data. Afterwards, we will create predictions and visualizations as to where are the best places for footbridges.
- Visulize Bridge Data on a Map
- Ability to filter through different bridge completion stages
- Ability to see multiple bridge completion stages at once
- Use of map clustering, enhances map peformance by an icon with the amount of bridges in an area. as you zoom in the bridge point appears.
- Dashboard containting graphs, charts, and tables to visualize bridge data
Trello Board - https://trello.com/b/Tz8190EG/labs-28-bridges-to-prosperity-d
Product Canvas - https://whimsical.com/LJC7f3n28cAwvU2uSrKYri
https://whimsical.com/bridgesd-archicture-FLKAKdVCjQuf94pmCpgWac
UX Design files - Files provided by stakeholder Brand Guide and Assets https://bridges.app.box.com/s/d9xafgdnzukar2f5frdn4stciud35e1y B2P Site Assessment Data https://bridges.app.box.com/s/vbgy6a9h0ohunzcuqgfg2mq8r0btvln5 Rwanda Administrative Levels and Codes https://bridges.app.box.com/s/21mix7vjnoi0v7q099fbr9ojl1gyy29j
- React
- react-map-gl
- Ant Design
- Context API
- Material-UI
- Axios
- Okta
- Recharts
- Supercluster
- useSupercluster
- framer motion
- React
- React allows for reusable components allowing for DRY code and everyone on the team already had experience with React.
Front end deployment: Here
Back end repo: Here
- Node.js
- Express
- PostgreSQL
- Docker
- express-ui
- swagger-jsdoc
This API supplies the map with all of its data points. The deployment is documented using Swagger. Currently modeling is not included in this deployment.
In order for the app to function correctly, the user must set up their own environment variables. There should be a .env file containing the following:
🚫These are the fields you will need to set up your project, replace them with the specifics for your app
* REACT_APP_CLIENT_ID=example - obtain from TPL
* REACT_APP_OKTA_ISSUER_URI="https://example-882474.okta.com" - obtain from TPL
* REACT_APP_API_URI=http://localhost:8005 - obtain from TPL
* REACT_APP_MAPBOX_TOKEN=example - obtain from TPL
🚫For all content - images, icons, etc, use this table to document permission of use. Remove the two placeholders and add you content to this table
| Image Filename | Source / Creator | License |
|---|---|---|
| doodles.png | Nicole Bennett | Creative Commons |
| rings.svg | Sam Herbert | MIT |
🚫Document what you used for testing and why
🚫explain how to install the required dependencies to get this project up and running with yarn and NPM
🚫replace these examples with your own
* typecheck - runs the TypeScript compiler
* build - creates a build of the application
* start - starts the production server after a build is created
* test - runs tests in **tests** directory \* eject - copy the configuration files and dependencies into the project so you have full control over them
When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
Please note we have a code of conduct. Please follow it in all your interactions with the project.
If you are having an issue with the existing project code, please submit a bug report under the following guidelines:
- Check first to see if your issue has already been reported.
- Check to see if the issue has recently been fixed by attempting to reproduce the issue using the latest master branch in the repository.
- Create a live example of the problem.
- Submit a detailed bug report including your environment & browser, steps to reproduce the issue, actual and expected outcomes, where you believe the issue is originating from, and any potential solutions you have considered.
We would love to hear from you about new features which would improve this app and further the aims of our project. Please provide as much detail and information as possible to show us why you think your new feature should be implemented.
If you have developed a patch, bug fix, or new feature that would improve this app, please submit a pull request. It is best to communicate your ideas with the developers first before investing a great deal of time into a pull request to ensure that it will mesh smoothly with the project.
Remember that this project is licensed under the MIT license, and by submitting a pull request, you agree that your work will be, too.
- Ensure any install or build dependencies are removed before the end of the layer when doing a build.
- Update the README.md with details of changes to the interface, including new plist variables, exposed ports, useful file locations and container parameters.
- Ensure that your code conforms to our existing code conventions and test coverage.
- Include the relevant issue number, if applicable.
- You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.
These contribution guidelines have been adapted from this good-Contributing.md-template.
See [Backend Documentation](🚫link to your backend readme here) for details on the backend of our project.