{"id":20375222,"url":"https://github.com/flipperzero-rs/flipperzero-template","last_synced_at":"2025-04-07T10:19:40.218Z","repository":{"id":146164375,"uuid":"609923122","full_name":"flipperzero-rs/flipperzero-template","owner":"flipperzero-rs","description":"A template for starting a flipperzero-rs project for the Flipper Zero🐬","archived":false,"fork":false,"pushed_at":"2025-01-26T13:25:00.000Z","size":23,"stargazers_count":79,"open_issues_count":0,"forks_count":12,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-03-31T09:03:29.157Z","etag":null,"topics":["flipperzero","rust-lang","template"],"latest_commit_sha":null,"homepage":"https://docs.rs/flipperzero","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/flipperzero-rs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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,"publiccode":null,"codemeta":null}},"created_at":"2023-03-05T16:33:37.000Z","updated_at":"2025-03-21T11:09:54.000Z","dependencies_parsed_at":null,"dependency_job_id":"f758825c-11a6-4a59-b99e-e8588143fe34","html_url":"https://github.com/flipperzero-rs/flipperzero-template","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flipperzero-rs%2Fflipperzero-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flipperzero-rs%2Fflipperzero-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flipperzero-rs%2Fflipperzero-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flipperzero-rs%2Fflipperzero-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/flipperzero-rs","download_url":"https://codeload.github.com/flipperzero-rs/flipperzero-template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247631834,"owners_count":20970069,"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":["flipperzero","rust-lang","template"],"created_at":"2024-11-15T01:29:22.885Z","updated_at":"2025-04-07T10:19:40.187Z","avatar_url":"https://github.com/flipperzero-rs.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# `flipperzero-template`🚀\n\nA template for kick-starting a Rust + FlipperZero project using [`flipperzero-rs`](https://github.com/flipperzero-rs/flipperzero) 🐬❤️🦀.\n\n# Usage\n\n## Initial setup\n\n1. Install [`rustup`](https://rust-lang.github.io/rustup/) by following the instructions on [`rustup.rs`](https://rustup.rs/).\n1. Install the nightly build tool-chain to support the[`different-binary-name`](https://doc.rust-lang.org/cargo/reference/unstable.html#different-binary-name) feature:\n    ```\n    rustup toolchain install nightly\n    ```\n1. Install [`cargo-generate`](https://github.com/cargo-generate/cargo-generate):\n    ```\n    cargo install cargo-generate\n    ```\n1. Use `rustup` to install the `thumbv7em-none-eabihf` target to the nightly build:\n    ```\n    rustup target add --toolchain nightly thumbv7em-none-eabihf\n    ```\n\n## Generate the project\n1. Use `cargo generate` to clone this template:\n    ```\n    cargo generate --git https://github.com/flipperzero-rs/flipperzero-template.git --name my-project\n    ```\n1. Switch into the local directory:\n    ```\n    cd my-project\n    ```\n\n## Build with `cargo build`\n\n```\ncargo build\n```\n\n## Copy the binary to your Flipper Zero\n\n\u003e [!IMPORTANT]\n\u003e This requires the `storage` command from [`flipperzero-tools`](https://crates.io/crates/flipperzero-tools) (`cargo install --locked flipperzero-tools`) or [`storage.py`](https://github.com/flipperdevices/flipperzero-firmware/blob/dev/scripts/storage.py) from the official SDK.\n\nThe resulting `.fap` binary can be found in [`target/thumbv7em-none-eabihf/debug`](target/thumbv7em-none-eabihf/debug).\n\n```sh\nstorage send target/thumbv7em-none-eabihf/release/my-project.fap /ext/apps/Examples/my-project.fap\n```\n\n## Build and run on change\n\n\u003e [!IMPORTANT]\n\u003e This requires the `run-fap` command from [`flipperzero-tools`](https://crates.io/crates/flipperzero-tools) (`cargo install --locked flipperzero-tools`) or [`runfap.py`](https://github.com/flipperdevices/flipperzero-firmware/blob/dev/scripts/runfap.py) from the official SDK.\n\nYou can automatically build and run your binary using [`cargo-watch`](https://crates.io/crates/cargo-watch) and the `run-fap` tool.\n\n```sh\ncargo watch -s 'cargo build --release \u0026\u0026 run-fap target/thumbv7em-none-eabihf/release/my-project.fap'\n```\n\n# License\n\nThis template is licensed under the [MIT License](https://github.com/flipperzero-rs/flipperzero/blob/v0.7.2/LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflipperzero-rs%2Fflipperzero-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fflipperzero-rs%2Fflipperzero-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflipperzero-rs%2Fflipperzero-template/lists"}