tooters's Introduction

Tooters: A Rust TUI-based Mastodon App

Tooters is a Rust-based Terminal User Interface (TUI) Mastodon app.

The project was created as a means to learn Rust and scratch a personal itch See the awesome python based toot, for something more complete.

Visit our website at toot.rs for more information and updates.

Status

Experimental, work in progress.

Known issues

does not load second page of toots (yet)

Features

View multiple toots on the screen at once
Rust-based TUI for a fast and efficient user experience
Easy navigation and interaction with toots

Installation

To install Tooters, you need to have Rust and Cargo installed on your system. If you don't have them installed, follow the instructions on the official Rust website.

Once Rust and Cargo are installed, you can install Tooters by running the following command:

cargo install tooters --locked

Usage

To start using Tooters, simply run the following command in your terminal:

tooters

You will be prompted to enter your Mastodon instance URL and login credentials. Once logged in, you can navigate and interact with toots using the keyboard shortcuts provided.

Keyboard Shortcuts

License

This project is licensed under either of:

Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

See CONTRIBUTING.md.

tooters's People

Contributors

Stargazers

Watchers

tooters's Issues

Login is not working correctly

The login flow is not yet working correctly. I've been testing with a preconfigured mastodon-data.toml file that I created outside of this app.

stateDiagram-v2
    LoggingIn: Logging In
    [*] --> LoadingCredentialsFile
    LoadingCredentialsFile --> VerifyingCredentials: load_credentials success
    LoadingCredentialsFile --> LoggingIn: load_credentials error
    VerifyingCredentials --> LoggedIn: verify_credentials success
    VerifyingCredentials --> LoggingIn: verify_credentials error
    LoggedIn --> [*]: send LoggedIn event
    LoggingIn --> VerifyingCredentials
    state LoggingIn {
        [*] --> InputServerUrl
        InputServerUrl --> RegisteringApp: read_server_url success
        InputServerUrl --> InputServerUrl: read_server_url error
        RegisteringApp --> InputAuthenticationCode: register_app success
        RegisteringApp --> InputServerUrl: register_app error
        InputAuthenticationCode --> CompleteAuth: read_authentication_code success
        InputAuthenticationCode --> InputServerUrl: read_authentication_code error
        CompleteAuth --> SavingCredentialsFile: complete_registration success
        CompleteAuth --> InputServerUrl: complete_registration error
        SavingCredentialsFile --> [*] : save_credentials success
        SavingCredentialsFile --> InputServerUrl: save_credentials error
    }

Support images

It might be nice to support showing images using e.g. https://docs.rs/viuer/latest/viuer/ or perhaps https://lib.rs/crates/pic

Perhaps https://github.com/okiwi6/tui-image would be the wrapper

Requires creating or finding a new List widget that supports displaying widgets rather than text (planned regardless)

joshka / tooters Goto Github PK