-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #6 from Jenil-Desai/main
v3.0.1
- Loading branch information
Showing
158 changed files
with
366 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,123 @@ | ||
# 📝 Notera | ||
|
||
Welcome to **Notera**, a simple notes desktop application designed for productivity and ease of use. Built with modern technologies, **Notera** offers a sleek, user-friendly interface for managing your notes efficiently. | ||
|
||
--- | ||
|
||
## 📑 Table of Contents | ||
|
||
1. [Overview](#-overview) | ||
2. [Technologies](#-technologies) | ||
3. [Packages & Libraries Used](#-packages--libraries-used) | ||
4. [Getting Started](#-getting-started) | ||
5. [Setup](#-setup) | ||
6. [Features](#-features) | ||
7. [Demo & Screenshots](#-demo--screenshots) | ||
8. [Acknowledgments](#-acknowledgments) | ||
9. [License](#-license) | ||
|
||
--- | ||
|
||
## 🌟 Overview | ||
|
||
Notera is a simple and intuitive desktop application for creating, organizing, and managing notes. With local storage and rich text editing, Notera is a perfect companion for staying organized across categories. The app runs seamlessly on Windows, macOS, and Linux, making it versatile and accessible. | ||
|
||
--- | ||
|
||
## 💻 Technologies | ||
|
||
Below is a breakdown of the core technologies used in this project. | ||
|
||
| 🖥️ Desktop Framework | Frontend Framework | Language | | ||
| -------------------- | ------------------ | -------- | | ||
| **Tauri** | **React.js** | **Rust** | | ||
| | **TypeScript** | | | ||
|
||
--- | ||
|
||
## 📦 Packages / Libraries Used | ||
|
||
This project uses the following essential libraries and packages: | ||
|
||
| Package / Library | Purpose | | ||
| -------------------- | ----------------------------- | | ||
| `Tailwind CSS` | Styling framework | | ||
| `Shadcn UI` | Prebuilt components library | | ||
| `Vite` | Build tool | | ||
| `Wouter` | Lightweight routing | | ||
| `Tip Tap` | Rich text editor | | ||
| `Day.js` | Lightweight date manipulation | | ||
| `Tauri-plugin-fs` | File system operations | | ||
| `Tauri-plugin-os` | Operating system utilities | | ||
| `Tauri-plugin-store` | Persistent local storage | | ||
|
||
--- | ||
|
||
## 🚀 Getting Started | ||
|
||
Follow these steps to set up the project in your local environment: | ||
|
||
1. Clone the repository: | ||
```bash | ||
git clone https://github.com/Jenil-Desai/notera.git | ||
``` | ||
2. Install dependencies: | ||
```bash | ||
npm install | ||
``` | ||
|
||
--- | ||
|
||
## ⚙️ Setup | ||
|
||
1. Start the project: | ||
```bash | ||
npm run dev | ||
``` | ||
2. A new window will open. Explore the desktop application. | ||
|
||
--- | ||
|
||
## 🎯 Features | ||
|
||
Explore the unique features available in this application: | ||
|
||
1. **Notes Saved Locally**: | ||
- All notes are stored locally on your machine, ensuring privacy and accessibility. | ||
2. **Create Categories**: | ||
- Organize your notes by creating categories for better management. | ||
3. **Categorize Notes**: | ||
- Assign notes to specific categories for quick access. | ||
4. **Rich Text Editor**: | ||
- Create beautifully formatted notes with a powerful text editor. | ||
5. **Notes CRUD**: | ||
- Add, edit, view, and delete notes with ease. | ||
|
||
--- | ||
|
||
## 🔗 Demo & Screenshots | ||
|
||
- Install the latest version of the application from the **[Releases](https://github.com/Jenil-Desai/notera/releases)** page. | ||
|
||
| Windows | Mac OS (May Not Work For Some Laptops) | Linux | | ||
| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | | ||
|  |  |  | | ||
|
||
--- | ||
|
||
## 🙏 Acknowledgments | ||
|
||
We’d like to thank the following resources: | ||
|
||
- **[Tauri 2.0 Docs](https://tauri.app/)** - Framework documentation. | ||
- **[Shadcn UI Docs](https://ui.shadcn.dev/)** - Component library documentation. | ||
|
||
--- | ||
|
||
## 📜 License | ||
|
||
This project is licensed under the [MIT License](LICENSE). See the [LICENSE](LICENSE) file for details. | ||
|
||
--- | ||
|
||
### Enjoy exploring and contributing to Notera! |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file removed
BIN
-2.96 KB
src-tauri/icons/Short-Logos/android/mipmap-hdpi/ic_launcher_foreground.png
Binary file not shown.
Binary file removed
BIN
-1.37 KB
src-tauri/icons/Short-Logos/android/mipmap-hdpi/ic_launcher_round.png
Binary file not shown.
Binary file not shown.
Binary file removed
BIN
-2.29 KB
src-tauri/icons/Short-Logos/android/mipmap-mdpi/ic_launcher_foreground.png
Binary file not shown.
Binary file removed
BIN
-1.3 KB
src-tauri/icons/Short-Logos/android/mipmap-mdpi/ic_launcher_round.png
Binary file not shown.
Binary file not shown.
Binary file removed
BIN
-4.01 KB
src-tauri/icons/Short-Logos/android/mipmap-xhdpi/ic_launcher_foreground.png
Binary file not shown.
Binary file removed
BIN
-2.13 KB
src-tauri/icons/Short-Logos/android/mipmap-xhdpi/ic_launcher_round.png
Diff not rendered.
Diff not rendered.
Binary file removed
BIN
-5.59 KB
src-tauri/icons/Short-Logos/android/mipmap-xxhdpi/ic_launcher_foreground.png
Diff not rendered.
Binary file removed
BIN
-2.71 KB
src-tauri/icons/Short-Logos/android/mipmap-xxhdpi/ic_launcher_round.png
Diff not rendered.
Diff not rendered.
Binary file removed
BIN
-7.65 KB
src-tauri/icons/Short-Logos/android/mipmap-xxxhdpi/ic_launcher_foreground.png
Diff not rendered.
Binary file removed
BIN
-3.41 KB
src-tauri/icons/Short-Logos/android/mipmap-xxxhdpi/ic_launcher_round.png
Diff not rendered.
Binary file not shown.
Binary file not shown.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Binary file removed
BIN
-1.31 KB
src-tauri/icons/Short-Transparent-Logos/android/mipmap-hdpi/ic_launcher.png
Diff not rendered.
Binary file removed
BIN
-3.21 KB
...ri/icons/Short-Transparent-Logos/android/mipmap-hdpi/ic_launcher_foreground.png
Diff not rendered.
Binary file removed
BIN
-1.31 KB
src-tauri/icons/Short-Transparent-Logos/android/mipmap-hdpi/ic_launcher_round.png
Diff not rendered.
Binary file removed
BIN
-1.36 KB
src-tauri/icons/Short-Transparent-Logos/android/mipmap-mdpi/ic_launcher.png
Diff not rendered.
Binary file removed
BIN
-2.34 KB
...ri/icons/Short-Transparent-Logos/android/mipmap-mdpi/ic_launcher_foreground.png
Diff not rendered.
Binary file removed
BIN
-1.36 KB
src-tauri/icons/Short-Transparent-Logos/android/mipmap-mdpi/ic_launcher_round.png
Diff not rendered.
Binary file removed
BIN
-2.18 KB
src-tauri/icons/Short-Transparent-Logos/android/mipmap-xhdpi/ic_launcher.png
Diff not rendered.
Binary file removed
BIN
-4.31 KB
...i/icons/Short-Transparent-Logos/android/mipmap-xhdpi/ic_launcher_foreground.png
Diff not rendered.
Binary file removed
BIN
-2.18 KB
src-tauri/icons/Short-Transparent-Logos/android/mipmap-xhdpi/ic_launcher_round.png
Diff not rendered.
Binary file removed
BIN
-2.96 KB
src-tauri/icons/Short-Transparent-Logos/android/mipmap-xxhdpi/ic_launcher.png
Diff not rendered.
Binary file removed
BIN
-6.05 KB
.../icons/Short-Transparent-Logos/android/mipmap-xxhdpi/ic_launcher_foreground.png
Diff not rendered.
Binary file removed
BIN
-2.96 KB
...tauri/icons/Short-Transparent-Logos/android/mipmap-xxhdpi/ic_launcher_round.png
Diff not rendered.
Binary file removed
BIN
-3.66 KB
src-tauri/icons/Short-Transparent-Logos/android/mipmap-xxxhdpi/ic_launcher.png
Diff not rendered.
Binary file removed
BIN
-8.6 KB
...icons/Short-Transparent-Logos/android/mipmap-xxxhdpi/ic_launcher_foreground.png
Diff not rendered.
Binary file removed
BIN
-3.66 KB
...auri/icons/Short-Transparent-Logos/android/mipmap-xxxhdpi/ic_launcher_round.png
Diff not rendered.
Binary file not shown.
Binary file not shown.
Diff not rendered.
Diff not rendered.
Binary file removed
BIN
-999 Bytes
src-tauri/icons/Short-Transparent-Logos/ios/AppIcon-20x20@2x-1.png
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Binary file removed
BIN
-2.97 KB
src-tauri/icons/Short-Transparent-Logos/ios/AppIcon-83.5x83.5@2x.png
Diff not rendered.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Binary file not shown.
Binary file not shown.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.