Skip to content
This repository has been archived by the owner on Jan 5, 2025. It is now read-only.

Commit

Permalink
add readme and license file
Browse files Browse the repository at this point in the history
  • Loading branch information
waozixyz committed Dec 18, 2024
1 parent c472b4a commit dcf9b2b
Show file tree
Hide file tree
Showing 2 changed files with 86 additions and 0 deletions.
9 changes: 9 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@


Copyright (c) 2024 Martin Schiller (@waozixyz) <hello@waozi.xyz>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
77 changes: 77 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
# myQuest

A personal life management application focused on visualization and habit tracking.

## Features

### Habit Tracker
Track your daily habits and build consistency:
- Mark completed habits on a calendar view
- Visual progress tracking
- Simple and intuitive interface

### Weekly Todo List
Organize your tasks by day of the week:
- Daily task organization
- Easy task management
- Week-at-a-glance view

### Life Timeline
Visualize your life journey:
- View your life progression on an interactive timeline
- Compare past experiences with future possibilities
- Gain perspective on time allocation
- Understand your life's bigger picture

### Routine Manager (Coming Soon)
Plan and visualize your daily routines:
- Create detailed daily schedules
- Visualize time allocation
- Optimize your daily workflow

## Development

### Prerequisites
- Rust toolchain (install via [rustup](https://rustup.rs/))
- Dioxus CLI

### Getting Started

1. Install the Rust toolchain:

```
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```
2. Install Dioxus CLI:
```
cargo install dioxus-cli
```
3. Clone the repository:
```
git clone https://github.com/waozixyz/myquest.git
cd myquest
```
4. Run the development server:
```
dx serve
```
### Building

Build for different platforms using Dioxus CLI:

- Web:
```
dx build --release --platform web
```
- Desktop:
```
dx build --release --platform desktop
```
- Android:
```
dx build --release --platform android
```
## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

0 comments on commit dcf9b2b

Please sign in to comment.