PROJECT_README.md

flakestry.dev

A public registry of Nix flakes aiming to supersede search.nixos.org.

Built using elm.land and Axum.

Maintainers:

• @domenkozar
• @sandydoo

Development

Prerequisites

You will need the following tools to build and run the project:

• Rust
• NPM
• TypeScript
• Elm
• Elm Land
• Postgres
• OpenSearch
• Caddy
• Docker
• OpenAPI Generator

Setup

JavaScript

Install JavaScript dependencies:

npm install

Postgres

Launch a postgres instance and create the database:

docker run --name flakestry-postgres -e POSTGRES_PASSWORD=postgres -p 5432:5432 -d postgres

Create the database and run the migrations:

DATABASE_URL=postgres://localhost:5432/flakestry sqlx database setup

OpenSearch

Launch an OpenSearch instance:

docker run -p 9200:9200 -p 9600:9600 -e "discovery.type=single-node" opensearchproject/opensearch:latest

Caddy

Launch the Caddy server:

caddy run

Run the backend

cd backend && cargo run

Run the frontend

cd frontend && elm-land server