Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sszabo11/spreadsheet-app-rust
Spreadsheet app in the terminal built with rust!!
https://github.com/sszabo11/spreadsheet-app-rust
rust spreadsheet spreadsheet-editor terminal terminal-app terminal-based terminal-ui
Last synced: about 1 month ago
JSON representation
Spreadsheet app in the terminal built with rust!!
- Host: GitHub
- URL: https://github.com/sszabo11/spreadsheet-app-rust
- Owner: sszabo11
- Created: 2024-08-17T07:45:15.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-08-26T07:22:03.000Z (4 months ago)
- Last Synced: 2024-08-27T06:52:35.319Z (4 months ago)
- Topics: rust, spreadsheet, spreadsheet-editor, terminal, terminal-app, terminal-based, terminal-ui
- Language: Rust
- Homepage:
- Size: 834 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 📝 Terminal Spreadsheet App 🦀
Terminal spreadsheet app! 🚀
## 🎉 Features
- **Keyboard Navigation**: Use arrow keys to move between cells effortlessly.
- **Text Editing**: Enter and edit text directly in any cell.
- **Minimal Flicker**: Optimized rendering to minimize flicker during screen updates.
- **Simple formulas**: Currently Sum and Product formulas work to a range of cells.
- **Commands (In progress)**: Enter command mode to execute tasks. Currently, only `:w` (save) works.
- **Save and load cells from database**: Automatically loads cell data from the database and saves it using the `:w` command.
- **View create and delete sheets**: Home page shows all sheets and ability to create or delete spreadsheets.
## 🏗️ Still working progress
- I still want to include all the future features listed below
- Still a bit buggy
- May not work on all terminals
## 🛠️ Installation
To get started, clone this repository and build the project using Cargo:
```bash
git clone https://github.com/sszabo11/spreadsheet-app-rust.git
cd spreadsheet-app-rust
cargo build --release
```
## 🧑💻 Usage
- Before running make sure you have a redis server on `127.0.0.1:6379`
- This is where the cell data will be stored
[](url)
Run the application with:
```bash
cargo run --release
```
## 🔮 Future Features
- **Complex formulas:** Support for advanced formulas.
- **Styling:** Apply different styles to cells (bold, italic, etc.).
- **Import Excel Sheets:** Import existing Excel sheets into the terminal app.
- **Export as Excel:** Export your spreadsheet as an Excel file.
## 🎮 Controls
- **Arrow Keys:** Navigate between cells.
- **Enter:** Start editing the selected cell.
- **Backspace:** Delete characters in the selected cell.
- **Esc:** Exit the application.
- **Tab:** To escape edit mode
- **+:** To create new sheet in home
- **_:** Delete sheet in home
## 📦 Dependencies
This project uses the following crates:
- **crossterm**: For terminal input/output handling.
- **redis**: For communicating to the database.
## 🥰 Feel free to use this