Skip to content

Commit 549c706

Browse files
committed
Copy from old branch
1 parent 2284abd commit 549c706

1 file changed

Lines changed: 72 additions & 4 deletions

File tree

README.md

Lines changed: 72 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,75 @@
1-
# Tauri + React
1+
# Phocus
22

3-
This template should help get you started developing with Tauri and React in Vite.
3+
Phocus is a minimalist Pomodoro and focus management app built with Tauri, designed to help users boost productivity by balancing work and rest effectively.
44

5-
## Recommended IDE Setup
5+
## I'm focusing on Window App.
66

7-
- [VS Code](https://code.visualstudio.com/) + [Tauri](https://marketplace.visualstudio.com/items?itemName=tauri-apps.tauri-vscode) + [rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer)
7+
## Features
8+
9+
- 🌟 **Pomodoro Timer**: Set customizable work and break intervals.
10+
- 📅 **Focus Room**: A distraction-free environment to stay concentrated.
11+
- 🔔 **Notifications**: Alerts for session changes (work, short break, long break).
12+
- 🎨 **Sleek UI**: Clean and user-friendly interface.
13+
-**Lightweight**: Built with Tauri, ensuring fast performance and minimal resource usage.
14+
15+
## Installation
16+
17+
### Prerequisites
18+
19+
Ensure you have the following installed:
20+
21+
- [Node.js](https://nodejs.org/)
22+
- [Rust](https://www.rust-lang.org/tools/install)
23+
- [Tauri](https://tauri.app)
24+
25+
### Clone the repository
26+
27+
```bash
28+
git clone https://github.com/datvn21/phocus.git
29+
cd phocus
30+
```
31+
32+
### Install dependencies
33+
34+
```bash
35+
pnpm install
36+
```
37+
38+
### Run the app
39+
40+
```bash
41+
pnpm run tauri dev
42+
```
43+
44+
## Build
45+
46+
To build the app for distribution:
47+
48+
```bash
49+
pnpm tauri build
50+
```
51+
52+
The output will be in the `src-tauri/target/release` directory.
53+
54+
## Contributing
55+
56+
Contributions are welcome! Feel free to fork the repo, create a branch, and submit a pull request.
57+
58+
1. Fork the repository.
59+
2. Create your branch: `git checkout -b feature/your-feature-name`
60+
3. Commit your changes: `git commit -m 'Add some feature'`
61+
4. Push to the branch: `git push origin feature/your-feature-name`
62+
5. Open a pull request.
63+
64+
## License
65+
66+
This project is licensed under the [MIT License](LICENSE).
67+
68+
## Acknowledgments
69+
70+
- Thanks to the [Tauri](https://tauri.app) team for their amazing framework.
71+
- Inspired by the concept of focused productivity and the Pomodoro technique.
72+
73+
---
74+
75+
Happy focusing! ✨

0 commit comments

Comments
 (0)