Seed Quickstart
Basic Rust-only template for your new Seed app.
1. Create a new project
-
You can use cargo generate to use this template.
$ cargo generate --git https://github.com/seed-rs/seed-quickstart.git --name my-project $ cd my-project
-
Alternatively, simply click on the green button Use this template on the GitHub profile of this quickstart.
-
Make sure Git doesn't automatically convert your newlines to CRLF because linters don't like it.
- Run
$ git config --global core.autocrlf
in your terminal and it should returninput
orfalse
. See Git docs for more info.
- Run
-
Clone your new repository to your local machine. I use GitKraken, but you are probably a better developer than me - use your favorite terminal.
2. Install / check required tools
-
Make sure you have basic tools installed:
- Rust
- Check:
$ rustc -V
=>rustc 1.43.1 (8d69840ab 2020-05-04)
- Install: https://www.rust-lang.org/tools/install
- Check:
- cargo-make
- Check:
$ cargo make -V
=>cargo-make 0.30.7
- Install:
$ cargo install cargo-make
- Check:
- Rust
-
Platform-specific tools like
ssl
andpkg-config
:- Follow recommendations in build errors (during the next chapter).
- Note: Don't hesitate to write notes or a tutorial for your platform and create a PR .
3. Prepare your project for work
- Open the project in your favorite IDE (I recommend VS Code + Rust Analyzer).
- Open a new terminal tab / window and run:
cargo make serve
- Open a second terminal tab and run:
cargo make watch
- If you see errors, try to fix them or write on our chat or forum.
- Modify files like
README.md
andCargo.toml
as you wish.
4. Write your website
- Open localhost:8000 in a browser (I recommend Firefox and Chrome).
- Modify source files (e.g.
/src/lib.rs
or/index.html
). - Watch compilation in the terminal tab where you run
cargo make watch
. - You can watch dev-server responses in the tab where you run
cargo make serve
. - Refresh your browser and see changes.
- Go to step 2.
5. Prepare your project for deploy
- Run
cargo make verify
in your terminal to format and lint the code. - Run
cargo make build_release
. - Upload
index.html
andpkg
into your server's public folder.- Don't forget to upload also configuration files for your hosting, see the Netlify one below.
# netlify.toml
[[redirects]]
from = "/*"
to = "/index.html"
status = 200
Other Seed quickstarts and projects
!!! New Rust-only quickstart in development! => Seeder !!!