The strongly recommended path to install Rust on your system is through rustup.
Instructions on how to install rustup itself can be found at https://rustup.rs.
rustup is more than a Rust installer -- it Rust's toolchain management system providing easy access to maintain the versions of core Rust tools, beyond the compiler, rustc. rustup" also manages the release channel you subscribe to. Although it is *highly* recommended to develop on the stablechannel, it can be useful to temporarily run on thenightlychannel for certain tools.rustupandcargo` make that easy.
The other key tool, included in the toolchain, is cargo. cargo is the package manager for Rust. cargo manages your project dependencies, via the project's Cargo.toml file, and offers project lifecycle commands you would expect, such as build, test, run. It's like the maven or sbt for Rust and has the advantage of learning lessons from those earlier tools.
sqlx is the database query engine used in the demo. It's a leading SQL Rust library, noted for compile-time safety and non-blocking async support.
sqlx provides a command-line interface, sqlx-cli, to manage database migrations. Install the CLI with:
cargo install --version="~0.6" sqlx-cli --no-default-features --features rustls,postgresRun sqlx --help to check that everything is working as expected.
To speed up the linking phase you have to install an alternative linker on your machine, corresponding to configuration specified in Cargo.toml:
cargo install -f cargo-binutils
rustup component add llvm-tools-preview- Ubuntu
sudo apt-get install lld clang- Arch,
sudo pacman -S lld clangbrew install michaeleisel/zld/zldThe project can be built with the following command:
cargo buildthis will by default build the project in Debug mode, to build in release mode
cargo build --releaseDuring development, you don't need to fully build the binary and can perform a compilation check, which is much quicker:
cargo checkor watch and check after file changes:
cargo watchIf no errors, this will generate the bankaccount server binary in target/[debug/release]/bankaccount. This is a normal executable and can be run in the command line. (For a Windows target, bankaccount.exe is produced.)
target/debug/bankaccountDuring development, you may also run the debug or release versions via cargo.
cargo runcargo run --releaseEnvironment variables can be provided for execution before the cargo command. Also, command-line arguments may be provided after --; e.g.,
RUST_LOG="debug" APP_ENVIRONMENT="local" cargo run -- --secrets ./resources/secrets.yamlor
cargo run -- --helpIn the project directory, we'll build and the release version of the server. This will take longer to build because cargo will build the optimized version, stripping out debug symbols and peforming additional optimizations. This will shrink the binary size and speed execution.
Building the debug version (minus the --release flag) builds much, much quicker.
From the project root directory:
cargo run --release -- --secrets ./resources/secrets.yamlYou'll see a bunch of log lines. The last one should say something like "... API listening on 0.0.0.0:8000 ..."
Now in another terminal, perform a health check on the server:
curl --location --request GET 'localhost:8000/api/v1/health'returns HTTP 200 and {"status":"Up"} payload.
cargo testthis will build and run all the tests, including unit/integration/documentation tests.
Two scripts under ./scripts directory can be used to setup up the database in a docker container.
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to makeareadme.com for this template.
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
Choose a self-explaining name for your project.
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
If you have ideas for releases in the future, it is a good idea to list them in the README.
State if you are open to contributions and what your requirements are for accepting them.
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
Show your appreciation to those who have contributed to the project.
For open source projects, say how it is licensed.
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.