{"id":13804738,"url":"https://github.com/seed-rs/seed-quickstart","last_synced_at":"2025-05-13T18:32:45.225Z","repository":{"id":48631757,"uuid":"159963880","full_name":"seed-rs/seed-quickstart","owner":"seed-rs","description":"Bare essentials to start a Seed app.","archived":false,"fork":false,"pushed_at":"2022-09-06T03:02:46.000Z","size":65,"stargazers_count":101,"open_issues_count":5,"forks_count":28,"subscribers_count":6,"default_branch":"master","last_synced_at":"2024-11-18T21:44:44.624Z","etag":null,"topics":["framework","frontend","rust","seed","template","web-assembly"],"latest_commit_sha":null,"homepage":"https://seed-rs.org/","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/seed-rs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":["MartinKavik"],"patreon":"martinkavik"}},"created_at":"2018-12-01T16:25:00.000Z","updated_at":"2024-08-13T03:37:13.000Z","dependencies_parsed_at":"2023-01-17T21:02:41.997Z","dependency_job_id":null,"html_url":"https://github.com/seed-rs/seed-quickstart","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/seed-rs%2Fseed-quickstart","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/seed-rs%2Fseed-quickstart/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/seed-rs%2Fseed-quickstart/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/seed-rs%2Fseed-quickstart/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/seed-rs","download_url":"https://codeload.github.com/seed-rs/seed-quickstart/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254003437,"owners_count":21997887,"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":["framework","frontend","rust","seed","template","web-assembly"],"created_at":"2024-08-04T01:00:53.464Z","updated_at":"2025-05-13T18:32:44.941Z","avatar_url":"https://github.com/seed-rs.png","language":"Rust","readme":"# Seed Quickstart\r\n\r\n\u003e Basic Rust-only template for your new Seed app.\r\n\r\n## 1. Create a new project\r\n\r\n1. You can use [cargo generate](https://github.com/ashleygwilliams/cargo-generate) to use this template.\r\n\r\n    ```bash\r\n    $ cargo generate --git https://github.com/seed-rs/seed-quickstart.git --name my-project\r\n    $ cd my-project\r\n    ```\r\n\r\n1. Alternatively, simply click on the green button **Use this template** on the GitHub [profile](https://github.com/seed-rs/seed-quickstart) of this quickstart.\r\n\r\n1. Make sure Git doesn't automatically convert your newlines to CRLF because linters don't like it.\r\n    - Run `$ git config --global core.autocrlf` in your terminal and it should return `input` or `false`. See [Git docs](https://git-scm.com/book/en/v2/Customizing-Git-Git-Configuration) for more info.\r\n\r\n1. Clone your new repository to your local machine. I use [GitKraken](https://www.gitkraken.com/), but you are probably a better developer than me - use your favorite terminal.\r\n\r\n## 2. Install / check required tools\r\n\r\n1. Make sure you have basic tools installed:\r\n\r\n   - [Rust](https://www.rust-lang.org)\r\n     - Check: `$ rustc -V` =\u003e `rustc 1.43.1 (8d69840ab 2020-05-04)`\r\n     - Install: https://www.rust-lang.org/tools/install\r\n   - [cargo-make](https://sagiegurari.github.io/cargo-make/)\r\n     - Check: `$ cargo make -V` =\u003e `cargo-make 0.30.7`\r\n     - Install: `$ cargo install cargo-make`\r\n\r\n1. Platform-specific tools like `ssl` and `pkg-config`:\r\n    - Follow recommendations in build errors (during the next chapter).\r\n    - _Note_: Don't hesitate to write notes or a tutorial for your platform and create a PR .\r\n\r\n## 3. Prepare your project for work\r\n\r\n1. Open the project in your favorite IDE (I recommend [VS Code](https://code.visualstudio.com/) + [Rust Analyzer](https://rust-analyzer.github.io/)).\r\n1. Open a new terminal tab / window and run: `cargo make serve`\r\n1. Open a second terminal tab and run: `cargo make watch`\r\n1. If you see errors, try to fix them or write on our [chat](https://discord.gg/JHHcHp5) or [forum](https://seed.discourse.group/).\r\n1. Modify files like `README.md` and `Cargo.toml` as you wish.\r\n\r\n## 4. Write your website\r\n\r\n1. Open [localhost:8000](http://localhost:8000) in a browser (I recommend Firefox and Chrome).\r\n1. Modify source files (e.g. `/src/lib.rs` or `/index.html`).\r\n1. Watch compilation in the terminal tab where you run `cargo make watch`.\r\n1. You can watch dev-server responses in the tab where you run `cargo make serve`.\r\n1. Refresh your browser and see changes.\r\n1. Go to step 2.\r\n\r\n## 5. Prepare your project for deploy\r\n\r\n1. Run `cargo make verify` in your terminal to format and lint the code.\r\n1. Run `cargo make build_release`.\r\n1. Upload `index.html` and `pkg` into your server's public folder.\r\n   - Don't forget to upload also configuration files for your hosting, see the [Netlify](https://www.netlify.com/) one below.\r\n\r\n```toml\r\n# netlify.toml\r\n[[redirects]]\r\n  from = \"/*\"\r\n  to = \"/index.html\"\r\n  status = 200\r\n```\r\n\r\n## Other Seed quickstarts and projects\r\n\r\n- [seed-rs/awesome-seed-rs](https://github.com/seed-rs/awesome-seed-rs)\r\n\r\n---\r\n\r\n**!!! New Rust-only quickstart in development! =\u003e [Seeder](https://github.com/MartinKavik/seeder) !!!**\r\n\r\n---\r\n","funding_links":["https://github.com/sponsors/MartinKavik","https://patreon.com/martinkavik"],"categories":["Quickstarts"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fseed-rs%2Fseed-quickstart","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fseed-rs%2Fseed-quickstart","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fseed-rs%2Fseed-quickstart/lists"}