Skip to content

development-setup.md

Latest commit

 

History

History
86 lines (57 loc) · 1.33 KB

development-setup.md

File metadata and controls

86 lines (57 loc) · 1.33 KB
Raw

Development Setup

This guide provides the steps to set up a local development environment for CleanServe.

Prerequisites

  • Rust (edition 2021)
  • Git
  • Docker (optional)

Installation

Clone the repository and navigate into the project directory:

git clone https://github.com/LyeZinho/cleanserve.git
cd cleanserve

Building

Compile the project in debug mode for local development:

cargo build

For production-ready binaries, use the release flag:

cargo build --release

Running the Server

Initialize the configuration:

cargo run -- init

Start the development server:

cargo run -- up

Debug Logging

Enable detailed logs by setting the RUST_LOG environment variable:

RUST_LOG=cleanserve=debug cargo run -- up

Testing

Run the test suite across all crates in the workspace:

cargo test

Docker Development

You can run the development environment using Docker Compose:

docker-compose up

This uses the Dockerfile.dev configuration.

Workspace Overview

The project is organized into 9 crates located in the crates/ directory:

  • cleanserve-shared
  • cleanserve-core
  • cleanserve-proxy
  • cleanserve-cli
  • cleanserve-watcher
  • cleanserve-vfs
  • cleanserve-bundle
  • cleanserve-inliner
  • cleanserve-preload