Skip to content

BloomTech-Labs/brew-plans-fe

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Brew Plans

You can find the deployed project at

Labs 19

Tavis Laudahl Jasmine Charles Sydney Blom TL - Elijah McKay


Contributors

Colin de Vries Justin Renninger Eli Citron Preston Middleton


Shannon Yoshikawa Jeff Butler Luis Villafranca Student
[ ]


MIT React Redux [Netlify Status](netlify link goes in these parenthesis) code style: prettier

Project Overview

Trello Board

Product Canvas

UX Design files

Brew Plans is a native mobile app for coffee connoisseurs that allow users to create, view, update, and delete recipes. In addition, Brew Plans provides recipes for new users, detailing how to create tried and trusted coffee recipes.

Key Features

  • User Sign Up and Login
  • User sign in with Google
  • User can view provided recipes, along with steps and timers for those recipes
  • User can view, create, update, and delete their own recipes
  • User can add steps to their recipe, along with timers with a specified duration

Tech Stack

Front end built using:

React Native

Why did you choose this framework?

  • Similar to React, which all developers have experience with
  • Widely used and supported
  • Many libraries and dependencies that work with React Native
  • Can create native apps for both Android and iOS

Front End Libraries:

  • React Native Paper
  • React Native TextInput Effects

Front end deployed to N/A

Back end built using:

NodeJS

  • NodeJS
  • PostgreSQL
  • SQLite
  • Firebase

APIs

Firebase

Firebase allows us to store users who sign in with Google easily.

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:

  • apiKey: AIzaSyDZKLP2FGiOx0aMXeDjAc3MOWSQa9pvJQg
  • authDomain: brew-plans.firebaseapp.com
  • databaseURL: https://brew-plans.firebaseio.com
  • projectId: brew-plans
  • storageBucket: brew-plans.appspot.com
  • messagingSenderId: 449923889220
  • appId: 1:449923889220:web:61af8a8355e54b3fba2411
  • measurementId: G-01P13B1Q2M

Content Licenses

Image Filename Source / Creator License
doodles.png Nicole Bennett Creative Commons
rings.svg Sam Herbert MIT

Installation Instructions

  1. cd frontend
  2. npm i

Other Scripts

N/A

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.

Known Bugs

  1. Instructions are null on recipe creation so it returns a 500 error. The recipe is created and you can view it under My Recipes in the app. When you touch that recipe and click start brew, the step's arent there because of the instructions being null when sent to the server. RecipeFormComponent
  2. When you add a recipe and click to add another recipe, all the inputs are still filled out with data from the last recipe that was added. The previous group set it up and the inputs aren't being handled in a normal way with local state, but being handled with redux and a custom function. Will probably have to redo that component without input being handled by redux.
  3. Also after adding a recipe and you try to make a new one, there will be an error from this.handleDurationChange which will cause the app to stop working and hang. The app needs to be restarted or it will just be stuck loading. The error is from the same component as #2 which is RecipeFormComponent
  4. When you login and then logout - the email and password fields aren't cleared. Might not be a huge bug but for security reasons at least the password input should clear on login. LoginForm

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.

About

No description, website, or topics provided.

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published