Skip to content

labs-sg1-refugee-stories/frontend02

Repository files navigation

Refugee Stories - Frontend02

Frontend02 for Refugee Stories Labs SG1 by Brandon Pampuch

Technical Design Document

Technical Design Document

Contributors

Brandon Pampuch

MIT React Typescript Netlify Status

Project Overview

A CMS for refugees to share their experiences with the rest of the world.

You can find the project at [URL NAME GOES HERE](copy and paste URL here).

Key Features

* Administrative login
* CMS for refugee users
* Connect to find local refugee camps

Tech Stack

Frontend built using:

React & Redux

Frontend deployed to Netlify

JWT

JSON Web Tokens are an open, industry standard RFC 7519 method for representing claims securely between two parties.

Water's like me. It's laaazy ... Boy, it always looks for the easiest way to do things A little happy sunlight shining through there. Let all these little things happen. Don't fight them. Learn to use them. Even the worst thing we can do here is good.

Google Maps API

A common API used for mapping and locating places using longitude and lattitude

Environment Variables

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

*  REACT_APP_apiKey - this is your Google API key, which can be generated in the Google Cloud Console

Content Licenses

Image Filename Source / Creator License
nick-fewings-532590-unsplash Nick Fewings [Creative Commons]

Testing

none

Installation Instructions

yarn install

Other Scripts

build - creates a build of the application start - starts the production server after a build is created 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.

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

About

Frontend02 for Refugee Stories Labs SG1 by Brandon Pampuch

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •