Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/freetonik/textpod
Extremely simple note-taking app inspired by "One Big Text File"
https://github.com/freetonik/textpod
Last synced: 3 days ago
JSON representation
Extremely simple note-taking app inspired by "One Big Text File"
- Host: GitHub
- URL: https://github.com/freetonik/textpod
- Owner: freetonik
- License: gpl-3.0
- Created: 2024-10-28T06:39:15.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-10-29T07:13:28.000Z (3 months ago)
- Last Synced: 2024-10-29T07:18:41.244Z (3 months ago)
- Language: Rust
- Size: 37.1 KB
- Stars: 42
- Watchers: 1
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/freetonik/textpod/actions?query=workflow%3AGNU%2FLinux)
[](https://github.com/freetonik/textpod/actions?query=workflow%3AmacOS)
[](https://github.com/freetonik/textpod/actions?query=workflow%3AWindows)
# Textpod
Local, web-based note-taking app inspired by "One Big Text File" idea. Short demo:
[](https://www.youtube.com/watch?v=VAqJJxaJNVM)
- Single page with all notes and a simple entry form (Markdown)
- All notes are stored in a single `notes.md` file
- Search/filtering when you start typing with `/`
- Start a link with `+` and Textpod will save a local single-page copy
- File and image attachments
## Installation
#### Using [Cargo](https://crates.io/crates/textpod) (cross-platform)
```console
cargo install textpod
```
#### Via [Homebrew](https://brew.sh/) (macOS and GNU/Linux)
```console
brew tap freetonik/tap
brew install textpod
```
In order to download webpages, you need to have `monolith` installed. `cargo install monolith` or `brew install monolith` (macOS). See [monolith](https://github.com/Y2Z/monolith) for more details.
## Usage
Run `textpod` in any directory. It will create a `notes.md` file if it doesn't exist. It will create `attachments` directory for file and image attachments.
Webpages are saved in `attachments/webpages`. You can specify the port with `-p` flag, e.g. `textpod -p 8080` and/or the address with `-l` flag, e.g. `textpod -l 0.0.0.0`.
## Docker
Docker image is available at [Docker Hub](https://hub.docker.com/r/freetonik/textpod).
E.g. run on port `8099`, mapping the `notes` directory (under current directory):
```
docker pull freetonik/textpod
docker run --rm --name textpod -d -v $(pwd)/notes:/app -p 8099:3000 freetonik/textpod
```
Or check out `docker-compose.yml`.
## Contributing
Feel free to open issues and pull requests. I want to keep the code very simple and accessible to beginners. The goal is not to create another feature-rich note-taking app, but to keep it simple and fast.
A "one big text file" idea is very powerful and I just want to make it slightly enhanced.