bloomtech-labs / geoseek-fe

GeoSeek

You can find the deployed project at Deployed Project.

Contributors

John Marshall	Michael Stevens	Dante Bui

George Raymond	Chase Redford	Anthony Lopez

Project Overview

Trello Board

Product Canvas

UX Design files

Our app GeoSeek aims to be a known name for creating engaging experiences through technology while promoting community growth and physical activity.

Key Features

• Seeing Gems on a map
• Create a Gem
• Seeing the difficulty of a gem
• Marking the gem Complete
• LeaderBoard

Tech Stack

Front end built using

React/Redux, MapBox/ReactMap-Gl

Our Front end framework details

• React/Redux was used for reusable and to create a large web application that can exchange data fast and simple.
• Mapbox so we could gain the mapping skills and marker placements that is coupled with the ReactMap-gl.

Front end deployed to Heroku

Back end built using

Nodejs

• fast deployment to get product to users.

• Express, Knex, PostgreSQL for DB

APIs

Authentication API here

JWT

Mapping API's

React Map Gl, ArcGis geocoding

Data Storage

Geoseek-be

Environment Variables

In order for the app to function correctly, the user must set up their own environment variables. There should be a .env.local file containing the following:

*  REACT_APP_DATABASE_URL - in the Heroku dashboard
*  REACT_APP_MAPBOX_TOKEN - in the Mapbox dashboard

Content Licenses

Image Filename	Source / Creator	License
doodles.png	Nicole Bennett	Creative Commons
rings.svg	Sam Herbert	MIT

Testing

• Jest and Enzyme are being used for tests Jest combined with Enzyme allow for effortless testing of React components with integration and unit tests.

Installation Instructions

Other Scripts

* 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

Contributing

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.

Issue/Bug Request

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.

Feature Requests

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.

Pull Requests

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.

Pull Request Guidelines

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

Attribution

These contribution guidelines have been adapted from this good-Contributing.md-template.

Documentation

See Backend Documentation for details on the backend of our project.

geoseek-fe's Issues

This could live in a config file

https://github.com/Lambda-School-Labs/geoseek-fe/blob/7523e3c9bced0a74c844d240f1118d324d4a9e66/src/components/createGem.js#L81

This could be in a config file

https://github.com/Lambda-School-Labs/geoseek-fe/blob/7523e3c9bced0a74c844d240f1118d324d4a9e66/src/actions/utils/axiosWithAuth.js#L7

View Gems search textbox looses focus after 1 key pressed