Skip to content

Improving the documentation and installation command for first time user #35

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nmoutschen merged 3 commits into from
Jan 13, 2022
Merged

Improving the documentation and installation command for first time user #35

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b294983
docs: added version requirements for Rust and SAM CLI
Jan 12, 2022
26656e7
Added makefile command for installing cross
Jan 12, 2022
e7b4fc9
Added make setup to check for dependency
Jan 13, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,21 @@ ARCH := aarch64-unknown-linux-gnu
all: build tests-unit deploy tests-integ
ci: build tests-unit

setup:
ifeq (,$(shell which rustc))
$(error "Could not found Rust compiler, please install it")
endif
ifeq (,$(shell which cargo))
$(error "Could not found Cargo, please install it")
endif
cargo install cross
ifeq (,$(shell which sam))
$(error "Could not found SAM CLI, please install it")
endif
ifeq (,$(shell which artillery))
$(error "Could not found Artillery, it's required for load testing")
endif

build:
cross build --release --target $(ARCH)
rm -rf ./build
Expand Down Expand Up @@ -35,4 +50,4 @@ tests-integ:
tests-load:
API_URL=$$(aws cloudformation describe-stacks --stack-name $(STACK_NAME) \
--query 'Stacks[0].Outputs[?OutputKey==`ApiUrl`].OutputValue' \
--output text) artillery run tests/load-test.yml
--output text) artillery run tests/load-test.yml
7 changes: 5 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,16 +18,19 @@ If you want to learn more about Rust on Lambda and how this project is structure

### Requirements

* [Rust](https://www.rust-lang.org/)
* [Rust](https://www.rust-lang.org/) 1.56.0 or higher
* [Cross](https://github.com/rust-embedded/cross) for cross-compilation to Arm64
* The [AWS SAM CLI](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-cli-install.html) for deploying to the cloud
* The [AWS SAM CLI](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-cli-install.html) 1.33.0 or higher for deploying to the cloud
* [Artillery](https://artillery.io/) for load-testing the application

### Commands

You can use the following commands at the root of this repository to test, build, and deploy this project:

```bash
# Optional: install Cross
make install-cross

# Run unit tests
make tests-unit

Expand Down