youwen5/cartographer
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Alternative TUI frontend for Canvas LMS
20 commits 1 branch 0 tags 135 KiB
Rust 80.7%
Nix 19.3%
Find a file
Youwen Wu 2d80aba11a
deps: add ratatui
2024-09-16 19:05:48 -07:00
src docs: update doccomment for get_from_endpoint 2024-09-12 14:50:59 -07:00
.envrc initial commit 2024-09-11 01:57:45 -07:00
.gitignore initial commit 2024-09-11 01:57:45 -07:00
Cargo.lock deps: add ratatui 2024-09-16 19:05:48 -07:00
Cargo.toml deps: add ratatui 2024-09-16 19:05:48 -07:00
flake.lock nix: use fenix instead of rust-overlay 2024-09-12 01:26:38 -07:00
flake.nix nix: add cargo-audit to devshell 2024-09-12 14:17:05 -07:00
LICENSE add license 2024-09-11 02:11:53 -07:00
README.md docs: update readme to mention scope 2024-09-12 14:45:09 -07:00
rustfmt.toml init rustfmt 2024-09-12 00:10:35 -07:00

README.md

Cartographer

An alternative TUI-based frontend for the Canvas LMS. Also implements libcanvas, a Rust library that wraps common Canvas API actions.

It is built for use by students/enrollees in courses, not instructors. There are no plans to support features specifically for instructors, but feel free to open a pull request to add them.

Building

Install Nix with flakes.

nix build

Or run directly:

nix run "git+https://code.youwen.dev/youwen5/cartographer.git"

You may also be able to compile it manually using cargo but this is not officially supported. Use the latest stable Rust toolchain. You must have openssl and the necessary libraries for Rust to link against.

Hacking

You can enter a development shell with all of the required dependencies (including openssl) with

nix develop

Or use direnv and simply direnv allow.