TaskMate is a simple and intuitive to-do list app built with React and Vite. It helps users efficiently manage tasks with features like adding, deleting, and marking tasks as completed.
This repository contains the core source code (src/) and static assets (public/) for TaskMate. You will need to set up a new Vite project and replace the necessary folders with the ones in this repository to run the app locally.
- Add, delete, and mark tasks as completed.
- Simple and clean user interface.
- Fast and responsive.
Check out the live version of TaskMate hosted online:
TaskMate Live Demo
Follow these steps to set up TaskMate locally:
-
Install Vite (if you don’t have it yet):
npm create vite@latest taskmate --template react
This will set up a new Vite project named
taskmatewith a React template. -
Navigate to the project directory:
cd taskmate -
Install dependencies:
npm install
-
Delete the existing
src/andpublic/folders in the newly created Vite project:rm -rf src/ public/
-
Copy the
src/andpublic/folders from the TaskMate repository and paste them into thetaskmateproject directory.
If your TaskMate app uses additional libraries or dependencies, you’ll need to install them. Check your src/ files for any external libraries, and install them:
For example:
npm install react-router-domIf your TaskMate app uses any environment variables (such as an API key), create a .env file in the root directory and add the necessary variables:
Example .env file:
VITE_WEATHER_API_KEY=your-api-key
-
Start the development server:
npm run dev
-
Open your browser and visit
http://localhost:5173to view the app running locally.
After following these steps, your project directory should look like this:
taskmate/
├── public/
│ └── index.html
├── src/
│ ├── App.jsx
│ ├── components/
│ └── styles/
├── .env (optional)
├── package.json
├── vite.config.js
└── node_modules/
Contributions are welcome! Please fork the repository, create a new branch, and submit a pull request.
- Fork the repository.
- Create a new branch:
git checkout -b feature-branch-name
- Commit your changes:
git commit -m "Description of changes" - Push your branch:
git push origin feature-branch-name
- Open a pull request.
- Live Demo: Link to your Firebase-hosted demo.
- Installation Process: Full instructions for creating a new Vite project, replacing the
srcandpublicfolders, and installing dependencies. - Contributing: Instructions for other developers to contribute to the project.
- Project Structure: Description of the directory structure after setup.