Phoenix

Maintainability and Test Coverage

Code Climate Badges

You can find the deployed project at Phoenix

Contributors

Emma Zarate	Amy Barba	Ian Sanchez	Nick Dailey
Nicole Antonacci	Cori Sternberg	Joshua Roy Draper

Project Overview

Trello Board

Product Canvas

UX Design Files

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

• Terms of service - Clearly Organized
• Meetup/Calendar based on location
• Real time event data detailed in calendar

Features coming with v2.0

• Upload profile photos
• Guidelines for taking profile pictures
• Add 'host' role
• Users match via a built in personality test

Tech Stack

Package Manager: NPM

• Industry standard package manager

Styling Library: Material UI

• Modular styling library that allows custom theme building

Frontend Framework: React

• Reusable components
• Faster rendering with virtual DOM
• Highly testable
• Great developer tools

Testing Library: Jest with React Testing Library

• Built-in code coverage
• Extensible framework
• Friendly CLI
• Immersive Watch mode

Front End deployed to: Heroku Git

Back End deployed to: Heroku Git

Back End Built Using:

• Node
• Express
• PostgreSQL

APIs

JSON Web T0ken

Internet standard for creating JSON access tokens signed using a private secret. Tokens are used to assert user authentication claims.

Bcrypt API

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.

Environment Variables

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.

Content Licenses

For all future content - images, icons, etc, use this table to document permission of use.

Image Filename	Source / Creator	License

Testing

Jest

React Testing Library

Installation Instructions

The following scripts install all dependencies.

npm i install

Or alternatively:

yarn install

Other Scripts

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

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.