readme: develop (d80a8236) · Commits · Public Repositories / s3s

README.md

+50 −0

Original line number	Diff line number	Diff line
		@@ -21,3 +21,53 @@ This experimental project intends to offer an ergonomic adapter for building S3-
		`s3s` implements Amazon S3 REST API in the form of a generic [hyper](https://github.com/hyperium/hyper) service. S3-compatible services can focus on the S3 API itself and don't have to care about the HTTP layer.

		`s3s-fs` implements the S3 API based on file system. It is designed for integration testing. DO NOT USE IT IN PRODUCTION.

		## Develop

		Toolchain

		+ Rust 1.66.1 or newer
		+ [just](https://github.com/casey/just)

		Get the source code

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

		#### Run basic checks and tests

		```bash
		just dev
		```

		#### Play the test server

		Install `s3s-fs`

		```bash
		just install
		```

		Run `s3s-fs` with example configuration

		```bash
		./scripts/s3s-fs.sh
		```

		```
		Access Key: AKIAIOSFODNN7EXAMPLE
		Secret Key: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
		```

		Then you can explore it with your favorite S3 client!

		#### Run the codegen

		```bash
		just download-model
		just codegen
		```

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