Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mkloz/to-do
React SPA(advanced to-do app) https://to-do.mkloz.online
https://github.com/mkloz/to-do
react spa to-do-app typescript vite zustand
Last synced: about 2 months ago
JSON representation
React SPA(advanced to-do app) https://to-do.mkloz.online
- Host: GitHub
- URL: https://github.com/mkloz/to-do
- Owner: mkloz
- License: mit
- Created: 2024-06-25T10:10:32.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-08-27T14:27:57.000Z (5 months ago)
- Last Synced: 2024-08-27T15:59:28.287Z (5 months ago)
- Topics: react, spa, to-do-app, typescript, vite, zustand
- Language: TypeScript
- Homepage: https://to-do.mkloz.online
- Size: 133 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
TO-DO
Developed with the software and tools below.
## 🔗 Quick Links
> - [📍 Overview](#-overview)
> - [📦 Features](#-features)
> - [🚀 Getting Started](#-getting-started)
> - [⚙️ Installation](#️-installation)
> - [🤖 Running to-do](#-running-to-do)
> - [🤝 Contributing](#-contributing)
> - [📄 License](#-license)
---
## 📍 Overview
Technology Stack:
- Frontend: ReactJS (Single Page Application)
Styling: CSS Modules for scoped, modular, and reusable styles
- State Management: Zustand for a lightweight and intuitive state management solution
- Data Fetching & Synchronization: React Query for server-state management, caching, synchronization, and more
- Type Checking: TypeScript for type safety and enhanced development experience
---
## 📦 Features
- Task Management:
Create, Edit, Delete Tasks: Users can easily add new tasks, edit existing ones, and delete tasks.
- Task Prioritization:
Allow users to prioritize tasks based on importance.
- Due Dates & Reminders: Users can set deadlines for tasks with optional reminders.
Task Categories: Organize tasks into customizable categories (e.g., Work, Personal, Shopping).
- User Experience:
Highly Responsive Design: The application will be fully responsive, providing a seamless experience across devices (mobile, tablet, desktop).
- Adaptive UI: The UI will adapt based on user interactions and context, ensuring a smooth and intuitive experience.
Data Persistence:
- Local Storage Integration: Tasks will be saved locally to maintain persistence across sessions without needing a backend.
- Offline Support: Users can access and modify their tasks even when offline. Changes will be synchronized when the connection is restored.
State Management:
---
## 🚀 Getting Started
### ⚙️ Installation
1. Clone the to-do repository:
```sh
git clone https://github.com/mkloz/to-do
```
2. Change to the project directory:
```sh
cd to-do
```
3. Install the dependencies:
```sh
npm install
```
### 🤖 Running to-do
Use the following command to run to-do:
```sh
npm run build && node dist/main.js
```
## 🤝 Contributing
Contributions are welcome! Here are several ways you can contribute:
- **[Submit Pull Requests](https://github.com/mkloz/to-do/blob/main/CONTRIBUTING.md)**: Review open PRs, and submit your own PRs.
- **[Join the Discussions](https://github.com/mkloz/to-do/discussions)**: Share your insights, provide feedback, or ask questions.
- **[Report Issues](https://github.com/mkloz/to-do/issues)**: Submit bugs found or log feature requests for To-do.
Contributing Guidelines
1. **Fork the Repository**: Start by forking the project repository to your GitHub account.
2. **Clone Locally**: Clone the forked repository to your local machine using a Git client.
```sh
git clone https://github.com/mkloz/to-do
```
3. **Create a New Branch**: Always work on a new branch, giving it a descriptive name.
```sh
git checkout -b new-feature-x
```
4. **Make Your Changes**: Develop and test your changes locally.
5. **Commit Your Changes**: Commit with a clear message describing your updates.
```sh
git commit -m 'Implemented new feature x.'
```
6. **Push to GitHub**: Push the changes to your forked repository.
```sh
git push origin new-feature-x
```
7. **Submit a Pull Request**: Create a PR against the original project repository. Clearly describe the changes and their motivations.
Once your PR is reviewed and approved, it will be merged into the main branch.
---
## 📄 License
This project is protected under the [MIT](https://choosealicense.com/licenses/mit) License. For more details, refer to the [LICENSE](./LICENSE) file.
---