federicobruzzone / tgt

TUI for Telegram written in Rust 🦀

Warning

This project is still in development and is not ready for use.

A simple TUI for Telegram

About

tgt is a terminal user interface for Telegram, written in Rust.

Contributing

Contributions to this project are welcome! If you have any suggestions, improvements, or bug fixes, feel free to submit a pull request. For more information, do not hesitate to contact us (see the Contact section).

The CONFIGURE_TDLIB.md file contains the steps to configure the tdlib in your local environment, starting from the compilation to the configuration of the environment variables.

Road Map

You can find the road map of the project here (in the pinned issues).

Building

You can use just, make or cargo, as build tools. If you want to use cargo, please make sure to read the Justfile or the Makefile to understand the flags used for each command. Here are the available commands:

just COMMAND
make COMMAND

COMMAND:
  all    # fmt, clippy, test, build
  build  # Build the project
  run    # Run the project
  fmt    # Format the code
  clippy # Run clippy
  test   # Run the tests
  clean  # Clean the project
  help   # Print the help message

License

This repository is licensed under the Apache License 2.0. Please review the license file provided in the repository for more information regarding the terms and conditions of the license.

Contact

• Email:
  • [[email protected]]
  • [[email protected]]
  • [[email protected]]
• GitHub:
  • FedericoBruzzone
  • Andreal2000

tgt's Issues

[Iteration Plan] Alpha Release

Plan Items

BNF for an item:

Item ::= "-" "[" Check? "]" "[" TestAnnotations FeatureAnnotations "]" Description

Check ::= "x"
Description ::= [\d\w\s]+
TestAnnotations ::= [✅❌]
FeatureAnnotations ::= [🏃✋🙅]

Test annotations:

Mark	Description
✅	Tests completed
❌	No Tests

Feature annotations:

Mark	Description
🏃	Work in progress
✋	Blocked task
🙅	Not assigned

Road Map

CI/CD

• CI/CD for Linux
• CI/CD for MacOS Intel
• CI/CD for MacOS arm64
• CI/CD for Windows
• CI/CD for release

Logger

• Add a logger implementation (tracing, tracing-error, tracing-subscriber)
• Add Non-Blocking Rolling File Appender
• Fix log timestamp (UTC -> local time)

Telegram API

• [🏃] project configuration for APIs
• [❌] Authentication
• [❌] Receive messages
• [❌] Send messages
• [❌] Handle updates from server
• [❌] Handle logout
• [❌] Handle view message (function)
• [❌🙅] Change user status to online and offline using options

TUI

• [❌] Handle small window for current components
• [❌] Create basic components
• [❌] Handle basic events

Components

App

• [❌] Handle login

Chat List

• [❌] Add ability to choose a chat
• [❌] Toggle chat list

Chat Window

• [❌] Display messages with time of arrival
• [❌] Display if messages has been readed
• [❌] Edit link
• [❌] Delete message
• [❌] Copy message
• [❌🙅] Reply link
• [❌] Handle message edited link link2
• [❌] Display message in multiple lines

Prompt Window

• [❌🙅] Add ability to write text without overflow and multiline

UI Backend

• [❌] Create basic backend
• [❌] Handle events from Crossterm

Deserialise and parse configuration

• [✅] Logger config
• [✅] Keybindings config (core window)
• [✅] Keybindings config for the components
• [✅] App config
• [✅] Theme config (miss documentation)
• [❌🏃] Telegram config
• [❌🙅] Add single config file for all settings

Use configuration

• Logger config
• Keybindings config (core window)
• Keybindings config for the components
• App config
• Theme
• [🏃] Telegram config
• [❌🙅] Language configuration file

Release

• Upload to crates.io
• Add install script (cross-platform)
• Delete old crates realeses
• Request an api key form telegram

---

For any kind of additional information do not hesitate to contact us.