This project came from a well rounded team member from our group. The idea approached almost naturally to her as it hit home on her current daily life. The story goes as the following;
You have an income salary or possibly multiple salaries. Your job includes tips/commission and it is sometimes difficult to keep track of your additional earnings.
AS A service worker
I WANT to keep track of my tips
SO THAT I can have manage my earnings in real time
GIVEN I want to track my tips
WHEN I visit the site for the first time
THEN I am presented with the homepage, which includes a welcome message for new users; navigation links for the homepage and the dashboard; and the option to log in or sign up
WHEN I click on the homepage option
THEN I am taken to the homepage
WHEN I click on any other links in the navigation
THEN I am prompted to either sign up or sign in
WHEN I choose to sign up
THEN I am prompted to create a username and password; and enter a monthly earning goal
WHEN I click on the sign-up button
THEN my user credentials are saved and I am logged into the site
WHEN I revisit the site at a later time and choose to sign in
THEN I am prompted to enter my username and password
WHEN I am signed in to the site
THEN I see navigation links for the homepage, the dashboard, and the option to log out
WHEN I click on the homepage option in the navigation
THEN I am taken to the homepage and presented with the options to enter my tip amount
WHEN I enter the tip amount and save
THEN it is added to the current earnings database
WHEN I click on the Current Earnings in the navigation
THEN I can see all the tips they have entered over time
~WHEN I click on the monthly goal option in the navigation
THEN my earning goal for the month will display with an option to update their monthly total
WHEN I reach my monthly goal
THEN I am presented with a pop-up that congratulates me for reaching my goal~
If your README is long, add a table of contents to make it easy for users to find what they need.
In order to create this application with checking off all the requirements criteria for this project, you willl need:
*Install 'node modules' folder by using command 'npm install' on your vs code terminal. You may refer to link presented to assist in downloading Node.js package manager and npm.
*Use a '.gitignore' file when creating your repository to ensure certain file are not tracked by Git and to stop the file from being reintroduced in later commits.
*Install 'package-lock.json'
*Install 'tailwind.config.js', link below will give you a step-by-step indication of the installation to Tailwind CSS.
https://tailwindcss.com/docs/installation
Provide instructions and examples for use. Include screenshots as needed.
To add a screenshot, create an assets/images
folder in your repository and upload your screenshot to it. Then, using the relative filepath, add it to your README using the following syntax:
```md
![alt text](assets/images/screenshot.png)
```
The Tip Jar project wouldn't have been able to be extecuted without the incredible collaborators. Introducing The Tip Jar team:
*Rujaine Mena
https://github.com/rujainemena
*Jusu Karneh
https://github.com/jusukarneh
*Lina Quintana
https://github.com/LinaQ97
WHEN it is the end of the month
THEN I am reminded: ARE WE RICH YET? cool, let's pay our bills and start again.