Skip to content

Commit

Permalink
Merge branch 'master' of https://github.com/labs-sg1-refugee-stories/…
Browse files Browse the repository at this point in the history 
…frontend02
  • Loading branch information
@Brandon-Pampuch
Brandon-Pampuch committed May 24, 2019
2 parents a0fb99d + 8c0f314 commit ea38662
Showing 1 changed file with 31 additions and 90 deletions.
121 changes: 31 additions & 90 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,152 +7,93 @@ Frontend02 for Refugee Stories Labs SG1 by Brandon Pampuch

## Contributors

🚫In Week 5 add contributor info below, make sure add images and edit the social links for each member. Add or delete these place-holders as needed

| [Student 1](https://github.com/) | [Student 2](https://github.com/) | [Student 3](https://github.com/) | [Student 4](https://github.com/) | [Student 5](https://github.com/) |
| :-----------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------: |
| [<img src="insert src here" width = "200" />](https://github.com/) | [<img src="insert src here" width = "200" />](https://github.com/) | [<img src="insert src here" width = "200" />](https://github.com/) | [<img src="insert src here" width = "200" />](https://github.com/) | [<img src="insert src here" width = "200" />](https://github.com/) |
| [<img src="https://github.com/favicon.ico" width="15"> ](https://github.com/) | [<img src="https://github.com/favicon.ico" width="15"> ](https://github.com/honda0306) | [<img src="https://github.com/favicon.ico" width="15"> ](https://github.com/Mister-Corn) | [<img src="https://github.com/favicon.ico" width="15"> ](https://github.com/NandoTheessen) | [<img src="https://github.com/favicon.ico" width="15"> ](https://github.com/wvandolah) |
| [ <img src="https://static.licdn.com/sc/h/al2o9zrvru7aqj8e1x2rzsrca" width="15"> ](https://www.linkedin.com/) | [ <img src="https://static.licdn.com/sc/h/al2o9zrvru7aqj8e1x2rzsrca" width="15"> ](https://www.linkedin.com/) | [ <img src="https://static.licdn.com/sc/h/al2o9zrvru7aqj8e1x2rzsrca" width="15"> ](https://www.linkedin.com/) | [ <img src="https://static.licdn.com/sc/h/al2o9zrvru7aqj8e1x2rzsrca" width="15"> ](https://www.linkedin.com/) | [ <img src="https://static.licdn.com/sc/h/al2o9zrvru7aqj8e1x2rzsrca" width="15"> ](https://www.linkedin.com/) |

<br>
<br>
Brandon Pampuch


🚫⬇️Optional examples of using images with links for your tech stack, make sure to change these to fit your project⬇️

![MIT](https://img.shields.io/packagist/l/doctrine/orm.svg)
![React](https://img.shields.io/badge/react-v16.7.0--alpha.2-blue.svg)
![Typescript](https://img.shields.io/npm/types/typescript.svg?style=flat)
[![Netlify Status](https://api.netlify.com/api/v1/badges/b5c4db1c-b10d-42c3-b157-3746edd9e81d/deploy-status)](netlify link goes in these parenthesis)
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)

🚫 more info on using badges [here](https://github.com/badges/shields)


## Project Overview

🚫Add description of project here
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

* feature one
* feature two
* feature three
* feature four
* feature five
* feature six
* Administrative login
* CMS for refugee users
* Connect to find local refugee camps


## Tech Stack

### Frontend built using:

#### _Frontend framework goes here_

*point one
*point two
*point three

🚫List the rest of the front end features and libraries in the same format as the framework above.

### Frontend deployed to `insert service here`

### Backend built using:

#### `backend framework goes here`
### Frontend built using:
React & Redux

*point one
*point two
*point three

🚫 List the rest of the backend end features and libraries in the same format as the framework above
### Frontend deployed to Netlify

## _Authentication API here_
## JWT

🚫Replace text below with a description of the API
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.

## _Payment API here_

🚫Replace text below with a description of the API

This is the way you take out your flustrations. Get away from those little Christmas tree things we used to make in school. Isn't it fantastic that you can change your mind and create all these happy things? Everything's not great in life, but we can still find beauty in it.

## _Misc API here_

🚫Replace text below with a description of the API
## Google Maps API

You can do anything your heart can imagine. In life you need colors. This is where you take out all your hostilities and frustrations. It's better than kicking the puppy dog around and all that so. I'm sort of a softy, I couldn't shoot Bambi except with a camera. Trees get lonely too, so we'll give him a little friend. We'll lay all these little funky little things in there.
A common API used for mapping and locating places using longitude and lattitude

## _Misc API here_

🚫Replace text below with a description of the API

When you do it your way you can go anywhere you choose. Let your heart take you to wherever you want to be. If I paint something, I don't want to have to explain what it is. A tree needs to be your friend if you're going to paint him. That's a son of a gun of a cloud. Even the worst thing we can do here is good.

## _Misc API here_

🚫Replace text below with a description of the API

Volunteering your time; it pays you and your whole community fantastic dividends. Maybe there's a happy little waterfall happening over here. You can spend all day playing with mountains. We don't have to be committed. We are just playing here. You have freedom here. The only guide is your heart. It's cold, but it's beautiful.

## 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:

🚫⬇️These are just examples, replace them with the specifics for your app⬇️

* REACT_APP_apiKey - this is your Google API key, which can be generated in the Google Cloud Console
* REACT_APP_authDomain - when you set up your Firebase project, this information will be in the dashboard
* REACT_APP_databaseURL - in the Firebase dashboard
* REACT_APP_projectID - in the Firebase dashboard
* REACT_APP_storageBucket - in the Firebase dashboard
* REACT_APP_messagingSenderId - in the Firebase dashboard
* REACT_APP_stripe_API - this is your public Stripe API key, generated in the Stripe dashboard
* REACT_APP_backendURL - optional for your local development server
* REACT_APP_clientid - this is the Stripe_connect clientID, generated in Stripe_connect settings
* REACT_APP_stripe_plan - this is the ID for a second Stripe subscription plan, generated under Stripe products

🚫In your backend, create a .env file that includes the following:

* STAGING_DB - optional development db for using functionality not available in SQLite
* NODE_ENV - set to "development" until ready for "production"
* JWT_SECRET - you can generate this by using a python shell and running import random''.join([random.SystemRandom().choice('abcdefghijklmnopqrstuvwxyz0123456789!@#\$%^&amp;*(-*=+)') for i in range(50)])
* SENDGRID_API_KEY - this is generated in your Sendgrid account
* stripe_secret - this is generated in the Stripe dashboard



## Content Licenses

🚫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](https://www.toptal.com/designers/subtlepatterns/doodles/) |
| rings.svg | Sam Herbert | [MIT](https://github.com/SamHerbert/SVG-Loaders) |

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


## Testing

🚫Document what you used for testing and why
none

## Installation Instructions

🚫explain how to install the required dependencies to get this project up and running with yarn and NPM
yarn install

### Other Scripts

🚫⬇️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


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.

Please note we have a [code of conduct](./CODE_OF_CONDUCT.md). Please follow it in all your interactions with the project.


### Issue/Bug Request

Expand Down Expand Up @@ -186,4 +127,4 @@ These contribution guidelines have been adapted from [this good-Contributing.md-

## Documentation

See [Backend Documentation](_link to your backend readme here_) for details on the backend of our project.
See [Backend Documentation](https://github.com/labs-sg1-refugee-stories/backend/blob/master/README.md) for details on the backend of our project.

0 comments on commit ea38662

Please sign in to comment.