Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/LukeMathWalker/build-your-own-jira-with-rust
A test-driven workshop to learn Rust building your own JIRA clone!
https://github.com/LukeMathWalker/build-your-own-jira-with-rust
Last synced: 1 day ago
JSON representation
A test-driven workshop to learn Rust building your own JIRA clone!
- Host: GitHub
- URL: https://github.com/LukeMathWalker/build-your-own-jira-with-rust
- Owner: LukeMathWalker
- License: mit
- Created: 2020-01-29T08:56:16.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2023-08-01T21:26:28.000Z (over 1 year ago)
- Last Synced: 2024-10-14T14:49:06.704Z (27 days ago)
- Language: Rust
- Size: 147 KB
- Stars: 936
- Watchers: 21
- Forks: 118
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-list - build-your-own-jira-with-rust - driven workshop to learn Rust building your own JIRA clone! | LukeMathWalker | 520 | (Rust)
README
# Build your own JIRA with Rust
You will be working through a series of test-driven exercises, or koans, to learn Rust while building your own JIRA clone!
This workshop is designed for people who have experience using other programming languages and are just getting
started with Rust.
If you run into any issue with the assumed level of Rust knowledge, please ping us and we'll sort it together!
## Requirements
- **Rust** (follow instructions [here](https://www.rust-lang.org/tools/install)).
If Rust is already installed on your system, make sure you are running on the latest compiler version (`cargo --version`).
If not, update using `rustup update` (or another appropriate command depending on how you installed Rust on your system).
- _(Optional)_ An IDE with Rust autocompletion support.
We recommend one of the following:
- [IntelliJ IDEA](https://www.jetbrains.com/idea/) with the [`intellij-rust`](https://intellij-rust.github.io) plugin;
- [Visual Studio Code](https://code.visualstudio.com) with the [`rust-analyzer`](https://marketplace.visualstudio.com/items?itemName=matklad.rust-analyzer) extension.
Checkout the [`rust-in-peace`](https://marketplace.visualstudio.com/items?itemName=gilescope.rust-in-peace) extension for a battery-included Rust setup on VS Code.
## Getting started
```bash
git clone [email protected]:LukeMathWalker/build-your-own-jira-with-rust.git
cd build-your-own-jira-with-rust
# Our `koans` CLI, you will need it to work through the exercises.
# You can run `koans --help` to check that everything is running properly
cargo install -f --path koans-framework
# Work on your solution in a branch.
git checkout -b my-solution
# Get started!
koans --path jira-wip
```
Follow the instructions shown in the terminal to get started with the first koan.
Run this command from the top-level folder
```bash
koans --path jira-wip
```
to verify your current solutions and move forward in the workshop.
Enjoy!
## References
Throughout the workshop, the following resources might turn out to be useful:
* [Rust Book](https://doc.rust-lang.org/book/)
* [Rust documentation](https://doc.rust-lang.org/std/) (you can also open the documentation offline with `rustup doc`!)
## Solutions
Under `jira-cli`, you can find a worked-out solution.
You can build it running:
```bash
cargo build --bin jira-cli
```
You can try it out running:
```bash
cargo run --bin jira-cli -- --help
```
You can run its tests running:
```bash
cargo test --bin jira-cli
```
You can browse its documentation with:
```bash
# We rely on the nightly compiler for automatic semantic link generation
cargo +nightly doc --manifest-path jira-cli/Cargo.toml --open
```