🌟 About The Project
Note: This is still a WORK IN PROGRESS
A TUI (Terminal User Interface) for dnote.
🏗️ Built With
🚀 Getting Started
This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.
🛠️ Prerequisites
- Install rust: https://www.rust-lang.org/
- Install dnote: https://github.com/dnote/dnote#installation
🏃 Running project
-
Clone the repo.
-
cd into repo.
-
Run tui
📝 Usage
🏃 Run
🏗️ Build
🧪 Run Tests
🎯 Roadmap
- Show basic TUI with three sections (Books, Pages, & Content)
- Create a dnote client
- Parse output from dnote cli to structs used by dnote client
- Add methods to perform write operations with dnote cli in dnote client
- Functionalities
- Read Operations
- Read books from dnote cli into tui
- Read pages from dnote cli into tui
- Read pages content from dnote cli into tui
- Show truncated pages content beside page id in pages section
- Write Operations
- Create a new book with page
- Edit a book's name
- Edit a page's content
- Delete a book's page
- Delete a book and all it's pages
- Read Operations
See the open issues for a full list of proposed features (and known issues).
🤝 Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feat/amazing-feature) - Commit your Changes (
git commit -m 'feat: add some amazing-feature') - Push to the Branch (
git push origin feat/amazing-feature) - Open a Pull Request
📄 License
Distributed under the MIT License. See LICENSE for more information.