Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@yoshimii
yoshimii committed Apr 25, 2020
1 parent a4569e2 commit 8c05b7d
Showing 1 changed file with 81 additions and 127 deletions.
208 changes: 81 additions & 127 deletions README.md
View file
@@ -1,190 +1,143 @@
# Phoenix

## Maintainability and Test Coverage

# Code Climate: Grade Badge
### Code Climate Badges

[![Maintainability](https://api.codeclimate.com/v1/badges/6107c810fc83d93a2733/maintainability)](https://codeclimate.com/github/Lambda-School-Labs/phoenix-fe/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/6107c810fc83d93a2733/test_coverage)](https://codeclimate.com/github/Lambda-School-Labs/phoenix-fe/test_coverage)


🚫 Note: All lines that start with 🚫 are instructions and should be deleted before this is posted to your portfolio. This is intended to be a guideline, feel free to add your own flare to it.

🚫 The numbers 1️⃣ through 5️⃣ next to each item represent the week that part of the docs needs to be comepleted by. Make sure to delete the numbers by the end of Labs.

🚫 Each student has a required minimum number of meaningful PRs each week per the rubric. Contributing to docs does NOT count as a PR to meet your weekly requirements.

# Phoenix

You can find the deployed project at [Phoenix](https://phoenix-fe-production.herokuapp.com/)

## Contributors


| [Emma Zarate](https://github.com/yoshimii) | [Amy Barba](https://github.com/Amybarba) | [Ian Sanchez](https://github.com/slimylizard) | [Nick Dailey](https://github.com/ndailey000) | [Nicole Antonacci](https://github.com/nantonacci) |
| :-------------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------: |
| [<img src="https://avatars3.githubusercontent.com/u/2327788?s=460&v=4" width = "200" />](https://github.com/yoshimii) | [<img src="https://avatars3.githubusercontent.com/u/46263700?s=460&v=4" width = "200" />](https://github.com/Amybarba) | [<img src="https://store.playstation.com/store/api/chihiro/00_09_000/container/US/en/999/UP0151-CUSA09971_00-AV00000000000002/1580206501000/image?w=240&h=240&bg_color=000000&opacity=100&_version=00_09_000" width = "200" />](https://github.com/slimylizard) | [<img src="https://avatars3.githubusercontent.com/u/49841573?s=460&v=4" width = "200" />](https://github.com/ndailey000) | [<img src="https://avatars1.githubusercontent.com/u/46404092?s=460&v=4" width = "200" />](https://github.com/nantonacci)
| [<img src="https://github.com/favicon.ico" width="15"> ](https://github.com/yoshimii) | [<img src="https://github.com/favicon.ico" width="15"> ](https://github.com/Amybarba) | [<img src="https://github.com/favicon.ico" width="15"> ](https://github.com/slimylizard) | [<img src="https://github.com/favicon.ico" width="15"> ](https://github.com/ndailey000) | [<img src="https://github.com/favicon.ico" width="15"> ](https://github.com/nantonacci)
| [ <img src="https://static.licdn.com/sc/h/al2o9zrvru7aqj8e1x2rzsrca" width="15"> ](https://www.linkedin.com/in/emmazarate/) | [ <img src="https://static.licdn.com/sc/h/al2o9zrvru7aqj8e1x2rzsrca" width="15"> ](https://www.linkedin.com/in/amy-barba-34020115/) | [ <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/in/nick-dailey-58342a18b/) | [ <img src="https://static.licdn.com/sc/h/al2o9zrvru7aqj8e1x2rzsrca" width="15"> ](https://www.linkedin.com/in/nicole-antonacci/) |
| [Cori Sternberg](https://github.com/CScori) | [Joshua Roy Draper](https://github.com/Classic_username) | |
| [<img src="https://avatars2.githubusercontent.com/u/49799016?s=460&v=4" width = "200" />](https://github.com/CScori) | [<img src="https://ca.slack-edge.com/T4JUEB3ME-UG4AC5AP4-42556aebd383-512" width = "200" />](https://github.com/Classic-username) |
| [<img src="https://github.com/favicon.ico" width="15"> ](https://github.com/Cscori) | [<img src="https://github.com/favicon.ico" width="15"> ](https://github.com/Classic-username) |
| [ <img src="https://static.licdn.com/sc/h/al2o9zrvru7aqj8e1x2rzsrca" width="15"> ](https://www.linkedin.com/in/cori-sternberg/) | [ <img src="https://static.licdn.com/sc/h/al2o9zrvru7aqj8e1x2rzsrca" width="15"> ](https://www.linkedin.com/in/joshua-draper-15267818a/) |
## Contributors



<br>
<br>
|[Emma Zarate](https://github.com/yoshimii)|[Amy Barba](https://github.com/Amybarba)|[Ian Sanchez](https://github.com/slimylizard)|[Nick Dailey](https://github.com/ndailey000)|
| :------: | :------: | :------: | :------: |
|[<img src="https://avatars3.githubusercontent.com/u/2327788?s=460&v=4" width = "200" />](https://github.com/yoshimii)|[<img src="https://avatars3.githubusercontent.com/u/46263700?s=460&v=4" width = "200" />](https://github.com/Amybarba)|[<img src="https://store.playstation.com/store/api/chihiro/00_09_000/container/US/en/999/UP0151-CUSA09971_00-AV00000000000002/1580206501000/image?w=240&h=240&bg_color=000000&opacity=100&_version=00_09_000" width = "200" />](https://github.com/slimylizard)|[<img src="https://avatars3.githubusercontent.com/u/49841573?s=460&v=4" width = "200" />](https://github.com/ndailey000)|
|[<img src="https://github.com/favicon.ico" width="15"> ](https://github.com/yoshimii)|[<img src="https://github.com/favicon.ico" width="15"> ](https://github.com/Amybarba)|[<img src="https://github.com/favicon.ico" width="15"> ](https://github.com/slimylizard)|[<img src="https://github.com/favicon.ico" width="15"> ](https://github.com/ndailey000)|
|[<img src="https://static.licdn.com/sc/h/al2o9zrvru7aqj8e1x2rzsrca" width="15"> ](https://www.linkedin.com/in/emmazarate/)|[<img src="https://static.licdn.com/sc/h/al2o9zrvru7aqj8e1x2rzsrca" width="15"> ](https://www.linkedin.com/in/amy-barba-34020115/)|[ <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/in/nick-dailey-58342a18b/) |
|[Nicole Antonacci](https://github.com/nantonacci)|[Cori Sternberg](https://github.com/CScori)|[Joshua Roy Draper](https://github.com/Classic_username)|
|[<img src="https://avatars1.githubusercontent.com/u/46404092?s=460&v=4" width = "200" />](https://github.com/nantonacci)| [<img src="https://avatars2.githubusercontent.com/u/49799016?s=460&v=4" width = "200" />](https://github.com/CScori)|[<img src="https://ca.slack-edge.com/T4JUEB3ME-UG4AC5AP4-42556aebd383-512" width = "200" />](https://github.com/Classic-username)|
|[<img src="https://github.com/favicon.ico" width="15"> ](https://github.com/nantonacci)|[<img src="https://github.com/favicon.ico" width="15"> ](https://github.com/Cscori)|[<img src="https://github.com/favicon.ico" width="15"> ](https://github.com/Classic-username)|
|[ <img src="https://static.licdn.com/sc/h/al2o9zrvru7aqj8e1x2rzsrca" width="15"> ](https://www.linkedin.com/in/nicole-antonacci/)|[ <img src="https://static.licdn.com/sc/h/al2o9zrvru7aqj8e1x2rzsrca" width="15"> ](https://www.linkedin.com/in/cori-sternberg/)|[ <img src="https://static.licdn.com/sc/h/al2o9zrvru7aqj8e1x2rzsrca" width="15"> ](https://www.linkedin.com/in/joshua-draper-15267818a/)|

![MIT](https://img.shields.io/packagist/l/doctrine/orm.svg)

![React](https://img.shields.io/badge/react-v16.12.0-blue.svg)


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

## Project Overview

[Trello Board](https://trello.com/b/T0wcLK6e/labspt7-phoenix)
[Trello Board](https://trello.com/b/T0wcLK6e/labspt7-phoenix)

[Product Canvas](https://www.notion.so/Phoenix-683a1eea00324cfa86240149783eb322)
[Product Canvas](https://www.notion.so/Phoenix-683a1eea00324cfa86240149783eb322)

[UX Design Files](https://www.figma.com/file/hSUe62UZgLeatX4bfg0BKt/Phoenix-Layout?node-id=31%3A46)

The current research suggests 40% of Americans are currently dating, 27% of
which are using online dating. This application is focused on serving a specific
The current research suggests 40% of Americans are currently dating, 27% of
which are using online dating. This application is focused on serving a specific
niche of those daters, specifically widows, widowers, and divorcees. This group
in particular need a different platform than what is currently on the market. This
in particular need a different platform than what is currently on the market. This
application is a hybrid of group meetings and dating individually. It will organize
events based on location and interests and draw enough users to create a party
type atmosphere to make connections less awkard and easier to make.

## Key Features

- Registration as a User or Host
- Terms of service - Clearly Organized
- Meetup/Calendar based on location
- Real time event data detailed in calendar
- Upload pictures
- Silhouette Guideline for Profile Pictures
- Users match via a built in personality test
- Registration as a User or Host

## Tech Stack
# React
- React as the front end will make for a quick web-app setup
- Terms of service - Clearly Organized
- Meetup/Calendar based on location
- Real time event data detailed in calendar
- Upload pictures
- Silhouette Guideline for Profile Pictures
- Users match via a built in personality test

# NPM
- NPM: prevent yarn/npm mix ups
## Tech Stack

# Material UI
- Material UI: Styling library with flexibility
### Package Manager: NPM

# LESS/SASS
- Clean CSS
- Industry standard package manager

### Front end built using:
### Styling Library: Material UI

- React
- Modular styling library that allows custom theme building

#### _Front end framework goes here_
### Frontend Framework: React

🚫 Why did you choose this framework?
- Reusable components
- Faster rendering with virtual DOM
- Highly testable
- Great developer tools

- point one
- point two
- point three
- point four
### Testing Library: Jest with React Testing Library

🚫List the rest of the front end features and libraries in the same format as the framework above.
- Built-in code coverage
- Extensible framework
- Friendly CLI
- Immersive Watch mode

**Front End deployed to:** [Heroku Git](https://phoenix-fe-production.herokuapp.com/)

**Back End deployed to:** [Heroku Git](https://phoenix-be-production.herokuapp.com/)

**Back End Built Using:**

- Express
- Node
- Create React App
- Websocket IO
- Cypress

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

# APIs

## 2️⃣ Authentication API here
- Node
- Express
- PostgreSQL

🚫Replace text below with a description of the API
## APIs

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.
## JSON Web T0ken

## 2️⃣ Payment API here
Internet standard for creating JSON access tokens signed using a private secret. Tokens are used to assert user authentication claims.

🚫Replace text below with a description of the API
## Bcrypt 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.
Bcrypt is a password hashing function that scales with computation power and hashes passwords with a salt. This scalability accounts for rapidly evolving harware and constant password length.

## 3️⃣ Misc API here
## Environment Variables

🚫Replace text below with a description of the API
In order for the app to function correctly, the user must set up their own environment variables. Currently there is no need for a .env file.

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.
## Content Licenses

## 3️⃣ Misc API here
For all future content - images, icons, etc, use this table to document permission of use.

🚫Replace text below with a description of the API
| Image Filename | Source / Creator | License |
| -------------- | ---------------- | -------------------|
| | | |
| | | |

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.
## Testing

## 3️⃣ 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.

# 3️⃣ 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 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

# 5️⃣ Content Licenses
### Jest

🚫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
### React Testing Library

| 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) |
# Installation Instructions
The following scripts install all dependencies.

# Testing
```shell
npm i install
```

### Jest
Or alternatively:

### React Testing Library
```shell
yarn install
```

# 4️⃣ Installation Instructions

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

## 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
```
coverage - runs the code coverage reporter
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
## 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.

Expand All @@ -193,10 +146,11 @@ Please note we have a [code of conduct](./CODE_OF_CONDUCT.md). Please follow it
## 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.

- 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

Expand Down

0 comments on commit 8c05b7d

Please sign in to comment.