Rust template

This template repository is part of a 4-week Rust course, start on week 1 here if you want to learn more about Rust!

This Rust template is meant to help you get quickly started with a new project. It is Codespaces enabled and it is pre-configured with useful extensions like the Rust Analyzer and GitHub Copilot

This repository is configured as a GitHub Template, so that you can start fresh with a new repository without carrying the history and commits of this repository. To get started you can click on the "Use this template" green button, or follow this link directly

This is the Rust template used as part of the Rust Bootcamp. There are 4 weeks in total:

week 1
week 2
week 3
week 4
Rust Template 👈 You are here!

🚀 Watch the Video course

Get started

To get started with this template, once you've generated the repository, run the following cargo command (replace my-project with the name of your project):

cargo init --name my-project .

This will initialize the project with the name you provided. You can now start editing the src/main.rs file and start building your project.

Make changes

Make changes to this repository so that it reflects your own project. Start by updating the license which is currently set to MIT. You can do this by editing the LICENSE file. You can also update the README.md file to reflect a descriptiton of your own project.

GitHub Actions

This template comes with a GitHub Actions workflow that will run on every push to the repository. The workflow will run cargo build and cargo test to make sure that your project builds and that all tests pass. You can find the workflow file in .github/workflows/rust.yml

GitHub Codespaces

This template is Codespaces enabled. This means that you can start a new Codespace from this repository and start working on your project right away. To do this, click on the green "Code" button and select "Open with Codespaces". This will start a new Codespace for you and you can start editing the src/main.rs file right away.

Resources

This template repository is part of a 4-week Rust course, start on week 1 here if you want to learn more about Rust!

O'Reilly Courses

DevOps command-line tools in Python and Rust