git0802 / TaskMates

Table of Contents

1. About The Project
2. Features
3. Tech Stack
4. Dependencies
5. Database Prep
6. Development
7. Contributing

About The Project

TaskMates App is a web-based platform designed to streamline task management and coordination among cohabitants. It simplifies the process of assigning, tracking, and completing tasks within a shared living space, promoting harmony and efficiency among users.

https://github.com/rorogab/TaskMates

Features

• User-Friendly Interface: An intuitive and user-friendly interface that makes task sharing and management a breeze.

• Task Assignment: Assign tasks to specific users, set due dates, and add task descriptions for clarity.

Tech Stack

• 
• 
• 
• 
• 
• 
• 
• 

Dependencies

• Run npm install in project directory. This will install server-related dependencies such as express.
• cd client and run npm install. This will install client dependencies (React).

Database Prep

• Access the MySQL interface in your terminal by running mysql -u root -p
• Create a new database called task_mates: CREATE DATABASE task_mates;
• Add the .env, to containing the MySQL authentication information for MySQL user. For example:

  DB_HOST=localhost
  DB_USER=root
  DB_NAME=task_mates

  DB_PASS=YOURPASSWORD

• Run npm run migrate in the project folder of this repository, in a new terminal window. This will create the tables tasks, usersand bills in your database.

  

Development

• Run npm start in project directory to start the Express server on port 5001
• In another terminal, do cd client and run npm run dev to start the client in development mode with hot reloading in port localhost 5173.

Contributing

We welcome contributions from the community.

(back to top)