An open-source task manager app built with React.js and Tailwind.css
This README provides information on how to set up, use, and contribute to the project.
- Task Creation: Create new tasks with titles, descriptions, and due dates.
- Task Editing: Edit existing tasks to update their details.
- Task Deletion: Remove tasks that are no longer needed.
- Task Completion: Mark tasks as complete or incomplete.
- Task Filtering: Filter tasks based on their status (completed/incomplete).
- User Authentication: Secure user login and registration.
- User Account Management: Manage user details and preferences.
To run Tasky locally, follow these steps:
- Clone the Repository:
git clone https://github.com/anoble2020/tasky.git
cd tasky
- Install Dependencies:
Ensure you have Node.js and npm installed. Then run:
npm install
- Start the Server:
npm start
The app will be available at http://localhost:3000.
- Navigate to the registration page.
- Enter your details and submit the form to create an account.
- Navigate to the login page.
- Enter your credentials and log in.
-
Creating a Task:
- Click on the "Add Task" button.
- Fill in the task details and submit the form.
-
Editing a Task:
- Click on the task you want to edit.
- Update the details and save changes.
-
Deleting a Task:
- Click on the delete icon next to the task.
-
Marking a Task as Complete:
- Click on the checkbox next to the task to mark it as complete.
-
Filtering Tasks:
- Use the filter options to view completed or incomplete tasks.
- GET /tasks: Retrieve all tasks.
- POST /tasks: Create a new task.
- PUT /tasks/:id: Update an existing task.
- DELETE /tasks/:id: Delete a task.
GET /tasks
json
[
{
"id": 1,
"title": "Task Title",
"description": "Task Description",
"dueDate": "2024-06-01T00:00:00.000Z",
"completed": false
}
]
We welcome contributions!
This project is licensed under the MIT License. See the LICENSE file for details.
For any questions or feedback, please leave a comment.