🌟 About The Project

Note: This is still a WORK IN PROGRESS

A TUI (Terminal User Interface) for dnote.

(back to top)

🏗️ Built With

• rust
• ratatui

(back to top)

🚀 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

1. Install rust: https://www.rust-lang.org/
2. Install dnote: https://github.com/dnote/dnote#installation

🏃 Running project

1. Clone the repo.

2. cd into repo.

   sh cd dnote-tui

3. Run tui

   sh cargo run

(back to top)

📝 Usage

🏃 Run

sh cargo run

🏗️ Build

sh cargo build

🧪 Run Tests

sh cargo test

(back to top)

🎯 Roadmap

• [x] Show basic TUI with three sections (Books, Pages, & Content)
• [x] Create a dnote client
  • [x] 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
    • [x] Read books from dnote cli into tui
    • [x] Read pages from dnote cli into tui
    • [x] 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

See the open issues for a full list of proposed features (and known issues).

(back to top)

🤝 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!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feat/amazing-feature)
3. Commit your Changes (git commit -m 'feat: add some amazing-feature')
4. Push to the Branch (git push origin feat/amazing-feature)
5. Open a Pull Request

(back to top)

📄 License

Distributed under the MIT License. See LICENSE for more information.

(back to top)