destinyfrith / coffeenotes-client

React client side portion of the Coffee Notes journaling app

Coffee Notes

Coffee journaling app that allows users to track their dial in processes with each new bag for the best taste and experience.

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation

About The Project

I am a passionate coffee lover who is constantly bringing home new bags to try. Each new coffee requires slightly different settings (grind size, extraction method) for best results. I created Coffee Apps to track each new bag and experience.

Coffee Notes stores all user entries in their dashboard. Users can add or update a coffee anytime. The fields being tracked are name, image, grind setting, brewing method, rating, flavor notes, and general thoughts. Through modified entries, users have the ability to fine tune each bag to produce the best cup.

(back to top)

Built With

• React.js
• Django

(back to top)

Getting Started

To get your own local version of this app follow these steps...

Prerequisites

For ease of use it is suggested to use npm. If you do now have npm you can install it using the command below

• npm

  npm install npm@latest -g

Installation assumes you have the server side repo already

1. Clone the repo

   git clone https://github.com/destinyfrith/coffeenotes-client.git

2. Install required packages

   npm install

3. Start app

   npm start

4. Clone/Open and run server code Server

(back to top)

coffeenotes-client's Issues

STRETCH: Ability to add a coffee from another user to current user's Wishlist

A user should be able to add coffees from other entries to their own personal wishlist

Given a user is on the Friends Dashboard
When they click "Add to Wishlist"
Then the name of that coffee should be added to their Wishlist page

The Wishlist will be accessible via their personal Dashboard

Register

If the user is not already a member they can click the register button and create an account.

Delete a Coffee

Users should be able to delete a coffee from their dashboard

Given a user is viewing their personal coffee collection
When they hit Delete
Then that coffee should get erased from their database
And they should be rerouted to their dashboard

Dashboard View

Given a user is registered already
When they log in
Then they will be able to view all of their previous coffee entries

Delete + Edit buttons will be under each coffee.

STRETCH: Ability to see coffees from other users

Users will have the ability to see a separate feed that includes entries from other users besides themselves

Given the user is logged in
When they click the Friends link in the nav bar
Then they will be taken to a new dashboard of entries from others

Edit a Coffee

All users should have the ability to edit any previous entries.

Given the user is viewing a coffee they created
When they select the option to edit a Coffee
Then the user should be directed to a form and given the ability to change the Coffee's information

Given the user is finished updating the Coffee information
When they click the Save button
Then the updated Coffee should be saved to the database
And the user should be redirected to their Dashboard

Given the user has decided not to edit the Coffee
When they click the Cancel button
Then the user should be redirected back to their Dashboard

Editable Information:

• Brewing Method
• Grind Setting
• Rating
• Flavor Profiles
• Additional Thoughts

View Coffee Entry

Setting up the view for the coffee entry.

Given the user has previous logged coffees,
When they are on the dashboard,
Then they should be able to see all of their coffees.

Entry details should include:

• Name
• Image
• Brewing Method
• Grind Setting
• Rating
• Flavor Profile(s)
• Additional Thoughts

Each entry should have an Edit/Delete

Add a New Coffee

Users should be able to add a new coffee

Given a user is viewing the Add Coffee page
When they hit submit
Then a new coffee should be added to the database and their personal dashboard
And they should be rerouted to their dashboard

Login

If a user is already a member, they can login with their username and password.

STRETCH: Ability to sort a user's dashboard coffees by rating

Users will have the ability to sort their own coffees by rating.

Given the user is on their dashboard
When they click the Sort By Rating dropdown
Then they can choose to sort from highest -> lowest or lowest -> highest rating
And their dashboard will be restructured

NavBar

NavBar up top should have an Add Coffee and Logout feature.