Plza Frontend Documentation

Deployed @ www.pleazza.com

Contributors

Buddy Agyin	Jeffrey Orndorff	John Chaing	Katrina Dierking	Cody Hayes	Freddie Thompson

Project Lead

Justin McCutcheon

Project Overview

Plza is a social media platform that connects pizza lovers with pizza shops, where they can find & rate pizza and organize pizza-related social gatherings and events.

• Trello Board

• Product Canvas

• UX Design files

Key Features

• Add Friends
• Create Promotions
• Full CRUD Dashboard for Users and Business Owners
• Rate and review pizza shops
• RSVP events at pizza shops

Tech Stack

Front end built using:

React

• Flexibility to develop with other frontend technologies
• Currently the most popular frontend library in the market
• Staying power (backed by Facebook)

Redux

• Single source of truth for where state lives
• Easier state management as app grows
• State Immutibility

Semantic UI

• Intuitive theming
• Easy to learn and maintain across the team
• Able to quickly design beautiful layouts

AWS Amplify

• Fast, Secure and Scalable
• Easy to deploy frontend applications
• Backed by industry standard AWS Services

Front end deployed to AWS Amplify

Back end built using:

Node / Express.js

• Same language for the entire stack
• Minimal framework; ease of use.
• Schema and data were previously built on top of Node/Express

PostgreSQL

• High Performance Database
• Strong reputation for reliability
• Free and open-source; easier to find and fix issues

APIs

Foursquare

The Foursquare Places API provides location based experiences with diverse information about venues, users, photos, and check-ins. The API supports real time access to places, Snap-to-Place that assigns users to specific locations, and Geo-tag. Additionally, Foursquare allows developers to build audience segments for analysis and measurement. JSON is the preferred response format.

GeoIP

GeoIP service provides accurate geolocation information based on domain or IP address.

Environment Variables

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

REACT_APP_BASE_URL = Local Backend Server e.g "http://localhost:4000/api"
REACT_APP_MAPBOX_TOKEN = pk.eyJ1IjoiZ3JlbnV0dGFnIiwiYSI6ImNrMnF1ajFkYzBqMTAzY244bmRpbW5nYW8ifQ.yX9laKkhJ8OmDQkwdnz8Hw
REACT_APP_ENCRYPT_SECRET=PizzaPlza2

Installation Instructions

• Create .env file with the above environment variables
• npm install to install all required dependancies

Other Scripts

• npm run start to start the app
• npm run test to start server using testing environment
• npm run coverage to gather test coverage |

Testing

For testing, we've used the following testing modules:

• @testing-library/react - light-weight solution for testing React components. It provides light utility functions on top of react-dom and react-dom/test-utils, in a way that encourages better testing practices.
• react-test-renderer - used to render React components to pure JavaScript objects, without depending on the DOM or a native mobile environment.
• redux-mock-store - used to test Redux async action creators and middleware. The mock store will create an array of dispatched actions which server as an action log for tests

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.