https://github.com/burgr033/flashme
terminal based flash card application written in Go utilizing the awesome bubble tea framework
https://github.com/burgr033/flashme
bubbletea charmbracelet flashcard flashcard-application flashcard-game go golang lipgloss
Last synced: about 2 months ago
JSON representation
terminal based flash card application written in Go utilizing the awesome bubble tea framework
- Host: GitHub
- URL: https://github.com/burgr033/flashme
- Owner: burgr033
- License: mit
- Created: 2024-03-01T22:56:28.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-04T12:34:03.000Z (over 2 years ago)
- Last Synced: 2025-03-05T22:58:09.786Z (over 1 year ago)
- Topics: bubbletea, charmbracelet, flashcard, flashcard-application, flashcard-game, go, golang, lipgloss
- Language: Go
- Homepage:
- Size: 236 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.MD
- License: LICENSE
Awesome Lists containing this project
README
# flashMe
FlashMe is a terminal-based flashcard application written in Go using the Bubble Tea framework. It provides a simple and efficient way to study and review flashcards right from your command line. FlashMe is designed to be easy to use, customizable, and distraction-free.
## Features
- flashMe offers a user-friendly interface where users can navigate through flashcards using keyboard commands.
- Each flashcard displays a question, and users can reveal the answer with a single keystroke.
## Installation
To get FlashMe, make sure you have Go installed on your system, and start by cloning the repo
```bash
go install github.com/burgr033/flashMe/cmd/flashMe@v1.0.0
```
## Usage
After installing FlashMe, start the application by running:
```bash
flashMe
```
flashMe needs a cards.txt in the current directory which has a tab separated list of questions
```list
Das ist eine Testfrage? Das ist eine Testantwort
What does $O(1)$ mean? Big-O describes the runtime complexity of an algorithm or program. $O(1)$ means, that the time complexity is constant
```
Follow the on-screen instructions to navigate through the flashcards and review your study materials.
## Contributing
As I am new to Go, contributions to FlashMe are very welcome! If you have any ideas, suggestions, or bug fixes, feel free to open an issue or submit a pull request on [GitHub](https://github.com/burgr033/flashme).
## Roadmap
* The next thing I will work on, is the ability to put in data after compilation. As of now you can only insert data by
## License
FlashMe is licensed under the [MIT License](LICENSE).
## Acknowledgements
FlashMe is built using Bubble Tea, a terminal UI framework for Go by Charmbracelet. Special thanks to the developers and contributors of Bubble Tea for providing such a powerful and versatile framework for building terminal-based applications.