- Rust 83.7%
- CSS 14%
- Just 1.3%
- PLpgSQL 0.8%
- Nix 0.2%
|
kleines Filmröllchen
6c626bbaf3
All checks were successful
Check and test / Cross-compile riscv64gc-unknown-linux-gnu (pull_request) Successful in 2m22s
Check and test / Cross-compile aarch64-unknown-linux-gnu (pull_request) Successful in 2m33s
Check and test / lint (pull_request) Successful in 1m23s
Check documentation kittehlist / check (pull_request) Successful in 4m6s
Check and test / build (pull_request) Successful in 8m24s
Check and test / Cross-compile riscv64gc-unknown-linux-gnu (push) Successful in 2m30s
Check and test / Cross-compile aarch64-unknown-linux-gnu (push) Successful in 2m37s
Check and test / lint (push) Successful in 3m49s
Check documentation kittehlist / check (push) Successful in 4m37s
Check and test / build (push) Successful in 7m5s
|
||
|---|---|---|
| .cargo | Use Cargo config inclusion for better config structure | |
| .config | tons and tons of CI configuration | |
| .forgejo | Make frontend buildable under non-wasm targets | |
| .vscode | rewrite frontend in Rust | |
| docs | Use Cargo config inclusion for better config structure | |
| frontend | address review comments | |
| kittehlist-model | implement API for list creation | |
| migrations | fix migration revert sql | |
| src | accessibility and basic search | |
| tests | implement API for list creation | |
| .editorconfig | migrate to lefthook | |
| .gitattributes | update git attributes | |
| .gitignore | Use Cargo config inclusion for better config structure | |
| build.rs | automatically run database init and migrations on startup | |
| Cargo.lock | changed search algorithm from purlu to frizbee | |
| Cargo.toml | Use Cargo config inclusion for better config structure | |
| example.kdl | migrate to knus (without fixing docs generator) | |
| justfile | Use single-threaded link fallback for all CI | |
| lefthook.toml | Make frontend buildable under non-wasm targets | |
| LICENSE-APACHE | tons and tons of CI configuration | |
| LICENSE-MIT | tons and tons of CI configuration | |
| README.md | automatically run database init and migrations on startup | |
| rustfmt.toml | update rustfmt edition | |
| shell.nix | updated nix shell for nixpkgs unstable | |
kittehlist
todo list for kittehs (and other beings) :3
kittehlist is a work-in-progress. For more information see the docs.
Installation
kittehlist is work-in-progress. The only current installation method is to build it from source. See the development documentation below.
Development
Requirements:
- Rust and Cargo for frontend and backend (recommended: via Rustup)
- A PostgreSQL database for kittehlist to connect to
- wasm-pack for building the Rust frontend
- esbuild for bundling CSS and static files
- (optional) diesel (ORM) which must be configured for a PostgreSQL database
- (optional) minify for minifying frontend release artifacts
- (optional) pre-commit for pre-commit checks that cover the most basic CI checks; install hooks with
pre-commit install - (optional) just script runner
For NixOS, a shell.nix development environment is provided.
The Justfile provides convenience scripts for development.
Web
The frontend website lives in the frontend subdirectory. It uses a combination of wasm-pack for the Rust WebAssembly build and esbuild for the CSS and static file bundling. The backend expects the resulting static files to live in target/frontend. just build-frontend performs all the necessary build steps.
License
Licensed under either of:
- Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
at your option.
The Inter Font is licensed under the SIL Open Font License 1.1. Copyright (c) 2016 The Inter Project Authors. See Inter License.
Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.