diff --git a/ms-gateway/README.md b/ms-gateway/README.md index fffb938..23904a2 100644 --- a/ms-gateway/README.md +++ b/ms-gateway/README.md @@ -1,15 +1,25 @@ # Microservice: Gateway -To install dependencies: +Set up tooling: ```bash -bun install +# General tools needed: +$ just install-tooling +# Bun dependencies: +$ just setup ms-gateway ``` -To run: +Develop: ```bash -bun run index.ts +$ just dev ms-gateway ``` -This project was created using `bun init` in bun v1.0.6. [Bun](https://bun.sh) is a fast all-in-one JavaScript runtime. +Which spins up a HTTP server along with a GraphiQL IDE at [http://127.0.0.1:4000](http://127.0.0.1:4000). + +Build: + +```bash +# Release builds: +$ just build ms-gateway +``` diff --git a/ms-gql-products/README.md b/ms-gql-products/README.md index e45a5d3..997c721 100644 --- a/ms-gql-products/README.md +++ b/ms-gql-products/README.md @@ -1,23 +1,29 @@ -# Microservice: To Do (GraphQL) +# Microservice: Products (GraphQL) + +Set up tooling: -Develop: ```bash -$ cargo lambda watch +# General tools needed: +$ just install-tooling +# Rust toolchain: +$ just setup ms-gql-products ``` -Test: +Develop: + ```bash -$ cargo lambda invoke --data-ascii '{"command": "hi"}' +$ just dev ms-gql-products ``` +Which spins up a HTTP server along with a GraphiQL IDE at [http://127.0.0.1:3075](http://127.0.0.1:3075). + Build: + ```bash -$ cargo lambda build --arm64 --release -# or, for x86 builds -$ cargo lambda build --release +# Release builds for ARM: +$ just build ms-gql-products +# Debug builds for ARM: +$ just build ms-gql-products debug ``` cargo-lambda uses [cargo-zigbuild to cross-compile](https://www.cargo-lambda.info/commands/build.html#compiler-backends), which uses the Zig compiler underneath. This removes the need to any virtualization when e.g. compiling ARM binaries from x86. - - -Check out the [CDK Construct made for cargo-lambda](https://github.com/cargo-lambda/cargo-lambda-cdk). diff --git a/ms-gql-reviews/README.md b/ms-gql-reviews/README.md index 8f61eb5..5e2dfab 100644 --- a/ms-gql-reviews/README.md +++ b/ms-gql-reviews/README.md @@ -1,23 +1,29 @@ -# Microservice: Media (GraphQL) +# Microservice: Reviews (GraphQL) + +Set up tooling: -Develop: ```bash -$ cargo lambda watch +# General tools needed: +$ just install-tooling +# Rust toolchain: +$ just setup ms-gql-reviews ``` -Test: +Develop: + ```bash -$ cargo lambda invoke --data-ascii '{"command": "hi"}' +$ just dev ms-gql-reviews ``` +Which spins up a HTTP server along with a GraphiQL IDE at [http://127.0.0.1:3085](http://127.0.0.1:3085). + Build: + ```bash -$ cargo lambda build --arm64 --release -# or, for x86 builds -$ cargo lambda build --release +# Release builds for ARM: +$ just build ms-gql-reviews +# Debug builds for ARM: +$ just build ms-gql-reviews debug ``` cargo-lambda uses [cargo-zigbuild to cross-compile](https://www.cargo-lambda.info/commands/build.html#compiler-backends), which uses the Zig compiler underneath. This removes the need to any virtualization when e.g. compiling ARM binaries from x86. - - -Check out the [CDK Construct made for cargo-lambda](https://github.com/cargo-lambda/cargo-lambda-cdk). diff --git a/ms-gql-users/README.md b/ms-gql-users/README.md index 8f61eb5..2a895f3 100644 --- a/ms-gql-users/README.md +++ b/ms-gql-users/README.md @@ -1,23 +1,29 @@ -# Microservice: Media (GraphQL) +# Microservice: Users (GraphQL) + +Set up tooling: -Develop: ```bash -$ cargo lambda watch +# General tools needed: +$ just install-tooling +# Rust toolchain: +$ just setup ms-gql-users ``` -Test: +Develop: + ```bash -$ cargo lambda invoke --data-ascii '{"command": "hi"}' +$ just dev ms-gql-users ``` +Which spins up a HTTP server along with a GraphiQL IDE at [http://127.0.0.1:3065](http://127.0.0.1:3065). + Build: + ```bash -$ cargo lambda build --arm64 --release -# or, for x86 builds -$ cargo lambda build --release +# Release builds for ARM: +$ just build ms-gql-users +# Debug builds for ARM: +$ just build ms-gql-users debug ``` cargo-lambda uses [cargo-zigbuild to cross-compile](https://www.cargo-lambda.info/commands/build.html#compiler-backends), which uses the Zig compiler underneath. This removes the need to any virtualization when e.g. compiling ARM binaries from x86. - - -Check out the [CDK Construct made for cargo-lambda](https://github.com/cargo-lambda/cargo-lambda-cdk). diff --git a/ms-queue/README.md b/ms-queue/README.md index 99bab0d..0217315 100644 --- a/ms-queue/README.md +++ b/ms-queue/README.md @@ -1,25 +1,27 @@ # Microservice: Queue -Develop: +Set up tooling: + ```bash -$ cargo lambda watch +# General tools needed: +$ just install-tooling +# Rust toolchain: +$ just setup ms-queue ``` -Test: +Develop: + ```bash -$ cargo lambda invoke --data-ascii '{"command": "hi"}' +$ just dev ms-queue ``` Build: + ```bash -$ cargo lambda build --arm64 --release -# or, for x86 builds -$ cargo lambda build --release +# Release builds for ARM: +$ just build ms-queue +# Debug builds for ARM: +$ just build ms-queue debug ``` cargo-lambda uses [cargo-zigbuild to cross-compile](https://www.cargo-lambda.info/commands/build.html#compiler-backends), which uses the Zig compiler underneath. This removes the need to any virtualization when e.g. compiling ARM binaries from x86. - - -Check out the [CDK Construct made for cargo-lambda](https://github.com/cargo-lambda/cargo-lambda-cdk). - -NOTE: We rely on https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#services-sqs-batchfailurereporting.