CONTRIBUTING.md

Development Guide

Toolchain	Version
Rust	^1.77.2
just	-
Python	^3.10
Docker	-

Get the source code

git clone https://github.com/Nugine/s3s.git
cd s3s

Run basic checks and tests

just dev

Open documentation

just doc

Run the codegen

just download-model
just codegen

It should change nothing if you are running the latest code.

Play the test server

Install s3s-fs from source

cargo install --path crates/s3s-fs --features binary

You can also use the shortcut

just install-s3s-fs

Or install from crates.io

cargo install s3s-fs --features binary

Run s3s-fs with example configuration

./scripts/s3s-fs.sh

Credentials used in the example configuration:

Access Key: AKEXAMPLES3S
Secret Key: SKEXAMPLES3S

Then you can explore it with your favorite S3 client!

Run E2E tests

Install s3s-proxy

just install-s3s-proxy

Run the combined server and save logs

./scripts/s3s-proxy.sh | tee target/s3s-proxy.log

Open a new terminal, then run the test suite

./scripts/mint.sh | tee target/mint.log