{"id":13566337,"url":"https://github.com/okp4/template-rust","last_synced_at":"2025-04-04T00:30:30.439Z","repository":{"id":43103207,"uuid":"510360435","full_name":"okp4/template-rust","owner":"okp4","description":"🖨 Template for Rust applications \u0026 smart contracts @okp4.","archived":false,"fork":false,"pushed_at":"2024-04-25T09:16:37.000Z","size":129,"stargazers_count":5,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-11-04T20:42:25.891Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/okp4.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2022-07-04T12:57:58.000Z","updated_at":"2024-04-25T09:16:40.000Z","dependencies_parsed_at":"2023-02-03T17:15:16.729Z","dependency_job_id":"384eeda1-c850-4019-a3e6-e2400c725edd","html_url":"https://github.com/okp4/template-rust","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":"okp4/template-oss","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/okp4%2Ftemplate-rust","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/okp4%2Ftemplate-rust/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/okp4%2Ftemplate-rust/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/okp4%2Ftemplate-rust/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/okp4","download_url":"https://codeload.github.com/okp4/template-rust/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247103305,"owners_count":20884023,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T13:02:07.436Z","updated_at":"2025-04-04T00:30:30.122Z","avatar_url":"https://github.com/okp4.png","language":"Rust","funding_links":[],"categories":["Rust"],"sub_categories":[],"readme":"# Rust Template\n\n\u003e Template for Rust projects @okp4.\n\n[![version](https://img.shields.io/github/v/release/okp4/template-rust?style=for-the-badge\u0026logo=github)](https://github.com/okp4/template-rust/releases)\n[![build](https://img.shields.io/github/actions/workflow/status/okp4/template-rust/build.yml?branch=main\u0026label=build\u0026style=for-the-badge\u0026logo=github)](https://github.com/okp4/template-rust/actions/workflows/build.yml)\n[![lint](https://img.shields.io/github/actions/workflow/status/okp4/template-rust/lint.yml?branch=main\u0026label=lint\u0026style=for-the-badge\u0026logo=github)](https://github.com/okp4/template-rust/actions/workflows/lint.yml)\n[![test](https://img.shields.io/github/actions/workflow/status/okp4/template-rust/test.yml?branch=main\u0026label=test\u0026style=for-the-badge\u0026logo=github)](https://github.com/okp4/template-rust/actions/workflows/test.yml)\n[![codecov](https://img.shields.io/codecov/c/github/okp4/template-rust?style=for-the-badge\u0026token=K5CYM8TQQY\u0026logo=codecov)](https://codecov.io/gh/okp4/template-rust)\n[![conventional commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg?style=for-the-badge\u0026logo=conventionalcommits)](https://conventionalcommits.org)\n[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=for-the-badge)](https://github.com/semantic-release/semantic-release)\n[![contributor covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg?style=for-the-badge)](https://github.com/okp4/.github/blob/main/CODE_OF_CONDUCT.md)\n[![License](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg?style=for-the-badge)](https://opensource.org/licenses/BSD-3-Clause)\n\n## Purpose \u0026 Philosophy\n\nThis repository holds the template for building Rust projects with a consistent set of standards across all [OKP4](https://github.com/okp4) projects. We are convinced that the quality of the code depends on clear and consistent coding conventions, with an automated enforcement (CI).\n\nThis way, the template promotes:\n\n- the use of [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/), [semantic versioning](https://semver.org/) and [semantic releasing](https://github.com/cycjimmy/semantic-release-action) which automates the whole package release workflow including: determining the next version number, generating the release notes, and publishing the artifacts (project tarball, docker images, etc.)\n- unit testing\n- linting via [rust-clippy](https://github.com/rust-lang/rust-clippy)\n- formatting via [rustfmt](https://github.com/rust-lang/rustfmt)\n- a uniform way of building via [cargo-make](https://github.com/sagiegurari/cargo-make)\n\n## How to use\n\n\u003e 🚨 do not fork this repository as it is a [template repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template)\n\n1. Click on [Use this template](https://github.com/okp4/template-rust/generate)\n2. Give a name to your project\n3. Wait until the first run of CI finishes\n4. Clone your new project and happy coding!\n\n⚠ Do not forget to adapt your project to your needs by editing the `Cargo.toml` file.\n\n## Prerequisites\n\nBe sure you have [Rust](https://www.rust-lang.org/tools/install) properly installed with [cargo-make](https://github.com/sagiegurari/cargo-make).\n\n## Build\n\n```sh\ncargo make\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fokp4%2Ftemplate-rust","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fokp4%2Ftemplate-rust","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fokp4%2Ftemplate-rust/lists"}