https://github.com/habedi/template-rust-project

A template for Rust projects
https://github.com/habedi/template-rust-project

quality-of-life rust rust-application rust-lang rust-library template-project template-repository

Last synced: 6 months ago
JSON representation

A template for Rust projects

• Host: GitHub
• URL: https://github.com/habedi/template-rust-project
• Owner: habedi
• License: apache-2.0
• Created: 2025-01-29T09:20:40.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2025-04-01T18:14:31.000Z (6 months ago)
• Last Synced: 2025-04-01T19:29:52.660Z (6 months ago)
• Topics: quality-of-life, rust, rust-application, rust-lang, rust-library, template-project, template-repository
• Language: Makefile
• Homepage:
• Size: 61.5 KB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE-APACHE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# A Template for Rust Projects



  

    

  






[![Tests](https://img.shields.io/github/actions/workflow/status/habedi/template-rust-project/tests.yml?label=tests&style=flat&labelColor=282c34&color=4caf50&logo=github)](https://github.com/habedi/template-rust-project/actions/workflows/tests.yml)

[![Lints](https://img.shields.io/github/actions/workflow/status/habedi/template-rust-project/lints.yml?label=lints&style=flat&labelColor=282c34&color=4caf50&logo=github)](https://github.com/habedi/template-rust-project/actions/workflows/lints.yml)

[![Linux Build](https://img.shields.io/github/actions/workflow/status/habedi/template-rust-project/build_linux.yml?label=linux%20build&style=flat&labelColor=282c34&color=4caf50&logo=linux)](https://github.com/habedi/template-rust-project/actions/workflows/build_linux.yml)

[![Windows Build](https://img.shields.io/github/actions/workflow/status/habedi/template-rust-project/build_windows.yml?label=windows%20build&style=flat&labelColor=282c34&color=4caf50&logo=windows)](https://github.com/habedi/template-rust-project/actions/workflows/build_windows.yml)

[![MacOS Build](https://img.shields.io/github/actions/workflow/status/habedi/template-rust-project/build_macos.yml?label=macos%20build&style=flat&labelColor=282c34&color=4caf50&logo=apple)](https://github.com/habedi/template-rust-project/actions/workflows/build_macos.yml)




[![Code Coverage](https://img.shields.io/codecov/c/github/habedi/template-rust-project?style=flat&labelColor=282c34&color=ffca28&logo=codecov)](https://codecov.io/gh/habedi/template-rust-project)

[![Code Quality](https://img.shields.io/codefactor/grade/github/habedi/template-rust-project?style=flat&labelColor=282c34&color=4caf50&logo=codefactor)](https://www.codefactor.io/repository/github/habedi/template-rust-project)

[![Crates.io](https://img.shields.io/crates/v/template-rust-project.svg?style=flat&labelColor=282c34&color=f46623&logo=rust)](https://crates.io/crates/template-rust-project)

[![Downloads](https://img.shields.io/crates/d/template-rust-project?style=flat&labelColor=282c34&color=4caf50&logo=rust)](https://crates.io/crates/template-rust-project)

[![Docs.rs](https://img.shields.io/badge/docs.rs-template--rust--project-66c2a5?style=flat&labelColor=282c34&logo=docs.rs)](https://docs.rs/template-rust-project)




[![Release](https://img.shields.io/github/release/habedi/template-rust-project.svg?style=flat&labelColor=282c34&color=f46623&logo=github)](https://github.com/habedi/template-rust-project/releases/latest)

[![Total Downloads](https://img.shields.io/github/downloads/habedi/template-rust-project/total.svg?style=flat&labelColor=282c34&color=8caf50&logo=github)](https://github.com/habedi/template-rust-project/releases)

[![Docs](https://img.shields.io/badge/docs-latest-007ec6?style=flat&labelColor=282c34&logo=readthedocs)](docs)

[![License](https://img.shields.io/badge/license-MIT%2FApache--2.0-007ec6?style=flat&labelColor=282c34&logo=open-source-initiative)](https://github.com/habedi/template-rust-project)

[![Status: Stable](https://img.shields.io/badge/status-stable-green.svg?style=flat&labelColor=282c34)](https://github.com/habedi/template-rust-project)

This is a template repository with a minimalistic structure to make it easier to start a new Rust project.

I share it here in case it might be useful to others.

## Features

- Minimalistic project structure

- Pre-configured GitHub Actions for running tests and making releases for different platforms

- Makefile for managing common tasks such as formatting, testing, linting, and building

- Example configuration files for common tools like `rustfmt`, `clippy`, and `editorconfig`

- GitHub badges for tests, builds, code quality and coverage, documentation, etc.

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to make a contribution.

## License

This project is licensed under either of these:

* MIT License ([LICENSE-MIT](LICENSE-MIT) or https://opensource.org/licenses/MIT)

* Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or https://www.apache.org/licenses/LICENSE-2.0)