https://github.com/p2panda/aardvark
https://github.com/p2panda/aardvark
collaboration gtk local-first p2panda text-editor
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/p2panda/aardvark
- Owner: p2panda
- License: gpl-3.0
- Created: 2024-12-07T11:29:56.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-12-26T15:48:50.000Z (4 months ago)
- Last Synced: 2024-12-26T16:32:28.332Z (4 months ago)
- Topics: collaboration, gtk, local-first, p2panda, text-editor
- Language: Rust
- Size: 240 KB
- Stars: 45
- Watchers: 7
- Forks: 1
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: COPYING
Awesome Lists containing this project
README
# Aardvark (working title)
MVP collaborative, local-first GTK text editor :)
## Development
### Getting Started
The [GNOME Builder IDE](https://builder.readthedocs.io/) is required to build
and run the project. It can be installed with flatpak.
1. [Install flatpak](https://flatpak.org/setup/) for your distribution.
2. Install [Builder](https://flathub.org/apps/org.gnome.Builder) for GNOME:
`flatpak install flathub org.gnome.Builder`
3. Clone the aardvark repo:
`git clone [email protected]:p2panda/aardvark.git && cd aardvark`
4. Open the Builder application and navigate to the aardvark repo.
- You may be prompted to install or update the SDK in Builder.
5. Run the project with `Shift+Ctrl+Space` or click the ► icon (top-middle of
the Builder appication).
### Multiple instances
Run builder in a separate dbus session if you need multiple instances to test
the application: `dbus-run-session org.gnome.Builder`.
### Diagnostics
Set the `RUST_LOG` environment variable to your verbosity setting and filter to
enable log-based diagnostics with [tracing](https://docs.rs/tracing). Example:
`RUST_LOG=debug` or `RUST_LOG=p2panda_net=INFO` etc.
## License
[GNU General Public License v3.0](COPYING)