Rust Starter Template

A template repository for starting your next Rust project.
Explore the docs »

· Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. References & Similar Projects

About The Project

This Repository is forked from and builds on jeremychone-channel/rust-base. I have put it together as I learned my way through Rust and forms a good starting point for what most Rust projects required.

(back to top)

In Built Features

The Rust Starter repository has the following features:

• Error handling best practice
• Cargo make starter
• Documentation build
• Unit and integration code snippets
• Rust development container
• Github CI actions
• VScode Rust extensions and settings

(back to top)

Getting Started

The Getting Started section contains prerequisites, installation and usage.

Prerequisites

As a pre-request to using this Rust starter repository you will need:

1. Rust tooling installed:

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

2. Rust up to date:

rustup update

3. Cargo make, a Rust task runner and build tool, installed:

cargo install --force cargo-make

Installation

This repository is set up as a template to let users generate new repositories with the same directory structure and files.

The easiest way to use this repository to get started is to:

1. Navigate to Github repository https://github.com/IanTeda/rust_starter
2. Click Use this template button up the top right
3. Select Create a new repository from the drop down menu

(back to top)

Usage

The following Cargo Make tasks are provided as a starter:

• Build

(back to top)

Roadmap

Add features as I think they have a place in the starter repository

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Your Name - @ian_teda - ian@teda.id.au

Project Link: https://github.com/IanTeda/personal_ledger

(back to top)

References Similar Projects

• YouTube Video
• jeremychone-channel/rust-base
• Blessed RS - An unofficial guide to the Rust ecosystem

(back to top)

Below is a list of similar applications:

• Name

(back to top)