Skip to content

Commit

Permalink
initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
forever8896 committed Oct 28, 2024
0 parents commit e62f7b7
Show file tree
Hide file tree
Showing 49 changed files with 9,426 additions and 0 deletions.
10 changes: 10 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
.DS_Store
node_modules
/build
/.svelte-kit
/package
.env
.env.*
!.env.example
vite.config.js.timestamp-*
vite.config.ts.timestamp-*
7 changes: 7 additions & 0 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"recommendations": [
"svelte.svelte-vscode",
"tauri-apps.tauri-vscode",
"rust-lang.rust-analyzer"
]
}
3 changes: 3 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"svelte.enable-ts-plugin": true
}
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2024 [Brian Pistar Industries]

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.
68 changes: 68 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
# Mindflow

A minimalist personal productivity companion that helps you track habits, manage tasks, and maintain focus - all while keeping your data local and private.

This is a Work in Progress project, set to change a lot.

## Features

- **📝 Journal**: Automatic daily entries tracking your accomplishments and reflections
- **✅ Task Management**: Simple to-do list to track daily tasks
- **⏱️ Pomodoro Timer**: Stay focused with customizable work/break sessions
- **🎯 Goal Setting**: Track long-term goals and motivations
- **📔 Notes**: Quick note-taking for ideas and thoughts
- **🔒 Privacy-First**: All data stored locally in a single file

## Technology

Built with:
- [Tauri](https://tauri.app/) - Lightweight, secure desktop application framework
- [Svelte](https://svelte.dev/) - Efficient, reactive UI framework
- [TypeScript](https://www.typescriptlang.org/) - Type-safe JavaScript
- [Rust](https://www.rust-lang.org/) - Performance and reliability for the backend

## Getting Started

### Prerequisites
- [Node.js](https://nodejs.org/) (v16 or later)
- [Rust](https://www.rust-lang.org/tools/install)
- [VS Code](https://code.visualstudio.com/) (recommended)

### Development Setup

1. Clone the repository:
```bash
git clone https://github.com/forever8896/mindflow.git
cd mindflow
```

2. Install dependencies:
```bash
npm install
```

3. Run in development mode:
```bash
npm run tauri dev
```

### Building

To create a production build:
```bash
npm run tauri build
```

## Contributing

Contributions are welcome! Please feel free to submit a Pull Request. This is still a simple work in progress aimed for personal use and helping me understand rust and tauri.

## License

[MIT License](LICENSE)

## Acknowledgments

- Built with [Tauri](https://tauri.app/)
- UI powered by [Svelte](https://svelte.dev/)
- Inspired by the need for a simple, private productivity tool
Binary file added logoForTauri.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added logotest.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added logotest.webp
Binary file not shown.
Loading

0 comments on commit e62f7b7

Please sign in to comment.