Repository files navigation

Kellnr is an open-sourceRust registry for crates. Think ofcrates.io but on your own hardware.

Find out more on:kellnr.io

You are welcome to contribute tokellnr. Create an issue or a pull-request here on Github.

If you want to contribute with code, here are some hints to get you started.

The following tools are needed to buildkellnr:Rust,NPM / Node.js andDocker.

kellnr is written in Rust with a UI invue.js. NPM and Node.js are only needed at build time, but not at runtime. The UI is hosted bykellnr itself, such that no Node.js is needed. Docker is needed for integration tests against thePostgreSQL backend.

Thebuild.rs installs allnode.js dependencies, builds the UI andkellnr. Simply run one of the commands below:

# Build Kellnrcargo build# Run Kellnrcargo run# Test Kellnrcargotest --all

kellnr uses Sqlite or PostreSQL as the storage backend for all crate related information. If you need a local PostgreSQL to test against, this Docker command sets one up on your local machine.

# Run local postgres container.docker run -it --rm -p 5432:5432 -e POSTGRES_PASSWORD=admin -e POSTGRES_USER=admin postgres

If you want to generate entities with Sea ORM from the database, run:

# in the folder, where the entities should be generated, where "kellnr-db" is the database name.sea-orm-cli generate entity -u postgresql://admin:admin@127.0.0.1/kellnr-db