https://github.com/pythoninthegrass/hello-rust
Rustacean hopeful
https://github.com/pythoninthegrass/hello-rust
Last synced: 11 months ago
JSON representation
Rustacean hopeful
- Host: GitHub
- URL: https://github.com/pythoninthegrass/hello-rust
- Owner: pythoninthegrass
- License: unlicense
- Created: 2024-03-11T16:33:20.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-11T22:52:45.000Z (almost 2 years ago)
- Last Synced: 2025-01-11T16:50:28.909Z (about 1 year ago)
- Language: Rust
- Homepage:
- Size: 29.3 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# hello-rust
[](https://github.com/pythoninthegrass/hello-rust/actions)
## Setup
### Cargo
* Install the rust toolchain in order to have cargo installed by following
[this](https://www.rust-lang.org/tools/install) guide.
* Install `hello-rust` via
```bash
# remote
cargo install --git https://github.com/pythoninthegrass/hello-rust
# local
cargo install --path .
```
## Development
### Setup
* Follow the [setup instructions](#setup) above to set up your environment
* Install [devbox](https://www.jetpack.io/devbox/docs/quickstart/)
```bash
curl -fsSL https://get.jetpack.io/devbox | bash
```
### Usage
* Basic commands
```bash
# install dependencies
devbox install
# enter devbox
devbox shell
# run app
devbox run start
# run tests
devbox run test
# create documentation
devbox run build-docs
# refresh devbox after making changes to devbox.json
refresh
# deactivate devbox
exit
```
## Further reading
[Introduction | Rust GitHub Template](https://rust-github.github.io/)
[Rust By Example](https://doc.rust-lang.org/rust-by-example/index.html)
[Rust | Devbox](https://www.jetpack.io/devbox/docs/devbox_examples/languages/rust/)
[Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)