$how Me The Money

Week 7 Group Project

Meetings are expensive, but sometimes we forget how expensive they are and feel the need to talk for too long about topics that are unimportant for the meeting purpose.

This is an app to display the costs of meetings, and track the costs of your meetings over time.

The idea of the App is to be able to display the real-time cost of a meeting as it occurs. This cost is calculated based on the hourly wages of the meeting's attendees and the current duration of the meeting.

The intended effect of this App is to make meeting attendees aware of how much this time is costing the business.

User Stories

MVP

As a user:

I want to register for the App under my name, and state my hourly wage
I want to start a new meeting, and add all the meeting members. (MVP: Add member names and wages manually)
I want to start my created meeting, and see a ($) cost tracker display the current meeting cost every second
I want to be able to save a meeting's cost, attendess, duration and date/time when it is finished for later viewing
I want to be able to view previous meetings in date/time order, and see more information about a past meeting.

Stretch

I want to be able to select existing users of the App as meeting attendees, so that our wages don't have to be shown / inputted manually. If a meeting attendee doesn't have an account, I want to be able to manually add them to the App.
I want to set a Maximum Cost an Maximum Duration for my Meeting, and see colourised progress bar displaying both a these
I want to be able to state my yearly salary rather than hourly rate as an option on register
I want to be able to view all meetings that I am an attenee for, and I want information about my meetings to not be visible to all users of the app.
I want to create a group of regular attendees for my meeting group to make setting up my meeting easier.
I want to see a graph of meeting costs over time
I want to be able to write notes or summaries for meetings upon saving them.

Views (Client Side)

name	purpose
Login	View for user to enter their login credentials
Register	View for user to sign up for the App
CreateMeeting	View for user to arrange meeting attendees and information before starting the timer
Meeting	View to display current meeting time, cost and other information while the meeting is in progress
History	Display a list of past meetings the user has attended with select preview information
PastMeeting	Display a single meeting from the history list, displaying more information and a list of attendees for the past meeting

Reducers (Client Side)

name	purpose
auth	Store information regarding user logins, auth status and auth errors
currentMeeting	Track meeting progress such as current cost and current duration
meetings	store the list of meetings the user has attended in the past
users	store the list of users who can attend meetings

Actions

meetings

type	data	purpose
RECEIVE_MEETINGS	meetings	retreive meetings from the db and store in redux
ADD_MEETING	meeting	Add a single meeting to the history after it is created

users

type	data	purpose
RECEIVE_USERS	users	retreive the users from the server

currentMeeting

type	data	purpose
START_MEETING	attendees ([]), meeting_name	a meeting has started, set initial meeting state
END_MEETING	null	Set meeting in progress flag to false
TICK_ONE_SECOND	null	Increase running total by 1s worth of $
RESET_MEETING	null	Revert to initial state

API (Client - Server)

Method	Endpoint	Protected	Usage	Response
Post	/api/auth/login	Yes	Log In a User	The Users JWT Token
Post	/api/auth/register	Yes	Register a User	The Users JWT Token
Get	/api/meetings	Yes	Get a Users Meeting Histroy	An Array of Meetings
Post	/api/meetings	Yes	Save a completed meeting	The Meeting that has been saved in db read format
Get	/api/meetings/:id/users	Yes	Get the attendees of a Meeting	An Array of User objects
Get	/api/users	Yes	Get the users of the app	An Array of User Objects

DB (Server Side)

There should be three tables for MVP

Users

Column Name	Data Type
id	Integer
user_name	String
first_name	String
last_name	String
hash	text

Meetings

Column Name	Data Type
id	Integer
meeting_name	String
duration	integer
attendees	integer
cost	Decimal

Attendees (Join Table M2M)

Many Users attend Many Meetings

Column Name	Data Type
user_id	Integer
meeting_id	Integer

Setup

Run the following commands in your terminal:

yarn install
yarn knex migrate:latest
yarn knex seed:run
mv .env_example .env

To run in development:

yarn dev
 - or -
npm run dev

To run in production:

yarn start
  - or -
npm start

Heroku!!!

Creating your app

Create your app with heroku create [name]

You can check that this was successful by running heroku apps to view a list of your apps

Adding postgres

Add postgresql (hobby dev) to your app at https://dashboard.heroku.com/apps/[APP NAME HERE]/resources

Check that pg has been added by running heroku addons to ensure the postgresql db is on your app

Deploying!

I have created several npm scripts that will be useful for deploying your app to heroku easily.

To push your local master branch to your heroku app:

yarn h:deploy
  - or -
npm run h:deploy

Run heroku migrations:

yarn h:migrate
  - or -
npm run h:migrate

Run heroku seeds:

yarn h:seed
  - or -
npm run h:seed

If ever you need to rollback, you can also:

yarn h:rollback
  - or -
npm run h:rollback

Ta-Da!

Your app should be deployed!

BecsController/Show-me-the-money-ruru-dev-work