AiaRup/work-track

A PWA app for desktop and mobile to track the number of massages and wages - daily and monthly.

Work Tracker

A PWA app for desktop and mobile to track the amount of massages and wage - daily and monthly.

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Screenshots
4. Roadmap
5. Contact

About The Project

I made this app for my husband so he could keep track of the amount of massages he gave and the salary he earned. The need for the app arose after months of "Where did I put the paper in which I wrote how many massages I did on Tuesday?"

The app supports the following languages:

• English
• Thai

(back to top)

Built With

• React
• Netlify
• React-intl
• Material-ui
• Material Dashboard React
• Firebase
• Dayjs
• Lottie

(back to top)

Getting Started

To get a local copy of the project and run it follow these simple steps:

Prerequisites

• npm

  npm install npm@latest -g

Installation

1. Create a project on firebase with firestore support.

2. Clone the repo

   git clone https://github.com/AiaRup/work-track.git

3. Install NPM packages

   npm install

4. Get the following variables from the new created firebase project and put them in an .env file in the root of the project (all the variables start with REACT_APP and then the name of the variable):

   REACT_APP_API_KEY = 'REACT_APP_API_KEY';
   REACT_APP_APP_ID = 'REACT_APP_APP_ID';
   REACT_APP_AUTH_DOMAIN = 'REACT_APP_AUTH_DOMAIN';
   REACT_APP_MEASUREMENT_ID = 'REACT_APP_MEASUREMENT_ID';
   REACT_APP_PROJECT_ID = 'REACT_APP_PROJECT_ID';
   REACT_APP_SENDER_ID = 'REACT_APP_SENDER_ID';
   REACT_APP_STORAGE_BUCKET = 'REACT_APP_STORAGE_BUCKET';

5. Start the project

   npm start

(back to top)

Usage

The app contains the following screens and components:

1. Dashboard
2. Monthly summary
3. Profile
4. Menu
5. Add, edit or delete a massage item

If you want, the app can be used to track any type of work all it takes is to change the functions that calculate the salary and change the forms and texts for the desired use.

(back to top)

Roadmap

• [] Errors handling
• [] Add tests

(back to top)

Contact

Aia Rupsom - LinkedIn

(back to top)