readme (4720ff63) · Commits · Public Repositories / s3s

CONTRIBUTING.md

+15 −3

Original line number	Diff line number	Diff line
		@@ -18,6 +18,12 @@ cd s3s
		just dev
		```

		#### Open documentation

		```bash
		just doc
		```

		#### Run the codegen

		```bash
		@@ -32,7 +38,13 @@ It should change nothing if you are running the latest code.
		Install `s3s-fs`

		```bash
		just install
		cargo install --path crates/s3s-fs --features binary
		```

		You can also use the shortcut

		```bash
		just install-s3s-fs
		```

		Run `s3s-fs` with example configuration
		@@ -53,7 +65,7 @@ Then you can explore it with your favorite S3 client!
		Install `s3s-proxy`

		```bash
		just install
		just install-s3s-proxy
		```

		Run the combined server and save logs
		@@ -65,5 +77,5 @@ Run the combined server and save logs
		Open a new terminal, then run the test suite

		```bash
		./scripts/mint.sh
		./scripts/mint.sh \| tee target/mint.log
		```

+2 −2

Original line number	Diff line number	Diff line
		@@ -23,7 +23,7 @@ This experimental project intends to offer an ergonomic adapter for building S3-

		`s3s-aws` provides useful types and integration with [`aws-sdk-s3`](https://crates.io/crates/aws-sdk-s3).

		`s3s-fs` implements the S3 API based on file system, as a sample implementation. It is designed for integration testing. DO NOT USE IT IN PRODUCTION.
		`s3s-fs` implements the S3 API based on file system, as a sample implementation. It is designed for integration testing, which can be used to [mock an S3 client](https://github.com/Nugine/s3s/blob/main/crates/s3s-fs/tests/it_aws.rs). It also provides a binary for debugging. [Play it!](./CONTRIBUTING.md#play-the-test-server)

		## How it works

		@@ -35,7 +35,7 @@ The diagram above shows how `s3s` works.

		`s3s` converts operation outputs or errors to HTTP responses after calling the user-defined service.

		The data types, serialization and deserialization are generated from the smithy model in [aws-sdk-rust](https://github.com/awslabs/aws-sdk-rust) repository, with some manual hacks.
		The data types, serialization and deserialization are generated from the smithy model in [aws-sdk-rust](https://github.com/awslabs/aws-sdk-rust) repository. We apply manual hacks to fix some problems in [smithy server codegen](https://awslabs.github.io/smithy-rs/design/server/overview.html) and make `s3s` ready to use now.

		## Contributing

+7 −1

Original line number	Diff line number	Diff line
		@@ -15,10 +15,16 @@ download-model:
		codegen:
		./scripts/codegen.sh

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

		install-s3s-proxy:
		cargo install --offline --path crates/s3s-proxy

		install:
		just install-s3s-fs
		just install-s3s-proxy

		sync-version:
		cargo set-version -p s3s-codegen 0.0.0
		cargo set-version -p s3s 0.3.2-dev