-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
16 changed files
with
669 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
# Generated by Cargo | ||
# will have compiled files and executables | ||
/target/ | ||
pkg | ||
|
||
# These are backup files generated by rustfmt | ||
**/*.rs.bk | ||
|
||
# node e2e test tools and outputs | ||
node_modules/ | ||
test-results/ | ||
end2end/playwright-report/ | ||
playwright/.cache/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,113 @@ | ||
[package] | ||
name = "frontend" | ||
version = "0.1.0" | ||
edition = "2021" | ||
|
||
[lib] | ||
crate-type = ["cdylib", "rlib"] | ||
|
||
[dependencies] | ||
axum = { version = "0.6.4", optional = true } | ||
console_error_panic_hook = "0.1" | ||
console_log = "1" | ||
cfg-if = "1" | ||
leptos = { version = "0.5", features = ["nightly"] } | ||
leptos_axum = { version = "0.5", optional = true } | ||
leptos_meta = { version = "0.5", features = ["nightly"] } | ||
leptos_router = { version = "0.5", features = ["nightly"] } | ||
log = "0.4" | ||
simple_logger = "4" | ||
tokio = { version = "1.25.0", optional = true } | ||
tower = { version = "0.4.13", optional = true } | ||
tower-http = { version = "0.4", features = ["fs"], optional = true } | ||
wasm-bindgen = "=0.2.89" | ||
thiserror = "1.0.38" | ||
tracing = { version = "0.1.37", optional = true } | ||
http = "0.2.8" | ||
|
||
[features] | ||
hydrate = ["leptos/hydrate", "leptos_meta/hydrate", "leptos_router/hydrate"] | ||
ssr = [ | ||
"dep:axum", | ||
"dep:tokio", | ||
"dep:tower", | ||
"dep:tower-http", | ||
"dep:leptos_axum", | ||
"leptos/ssr", | ||
"leptos_meta/ssr", | ||
"leptos_router/ssr", | ||
"dep:tracing", | ||
] | ||
|
||
# Defines a size-optimized profile for the WASM bundle in release mode | ||
[profile.wasm-release] | ||
inherits = "release" | ||
opt-level = 'z' | ||
lto = true | ||
codegen-units = 1 | ||
panic = "abort" | ||
|
||
[package.metadata.leptos] | ||
# The name used by wasm-bindgen/cargo-leptos for the JS/WASM bundle. Defaults to the crate name | ||
output-name = "frontend" | ||
|
||
# The site root folder is where cargo-leptos generate all output. WARNING: all content of this folder will be erased on a rebuild. Use it in your server setup. | ||
site-root = "target/site" | ||
|
||
# The site-root relative folder where all compiled output (JS, WASM and CSS) is written | ||
# Defaults to pkg | ||
site-pkg-dir = "pkg" | ||
|
||
# [Optional] The source CSS file. If it ends with .sass or .scss then it will be compiled by dart-sass into CSS. The CSS is optimized by Lightning CSS before being written to <site-root>/<site-pkg>/app.css | ||
style-file = "style/main.scss" | ||
# Assets source dir. All files found here will be copied and synchronized to site-root. | ||
# The assets-dir cannot have a sub directory with the same name/path as site-pkg-dir. | ||
# | ||
# Optional. Env: LEPTOS_ASSETS_DIR. | ||
assets-dir = "public" | ||
|
||
# The IP and port (ex: 127.0.0.1:3000) where the server serves the content. Use it in your server setup. | ||
site-addr = "127.0.0.1:3000" | ||
|
||
# The port to use for automatic reload monitoring | ||
reload-port = 3001 | ||
|
||
# [Optional] Command to use when running end2end tests. It will run in the end2end dir. | ||
# [Windows] for non-WSL use "npx.cmd playwright test" | ||
# This binary name can be checked in Powershell with Get-Command npx | ||
end2end-cmd = "npx playwright test" | ||
end2end-dir = "end2end" | ||
|
||
# The browserlist query used for optimizing the CSS. | ||
browserquery = "defaults" | ||
|
||
# Set by cargo-leptos watch when building with that tool. Controls whether autoreload JS will be included in the head | ||
watch = false | ||
|
||
# The environment Leptos will run in, usually either "DEV" or "PROD" | ||
env = "DEV" | ||
|
||
# The features to use when compiling the bin target | ||
# | ||
# Optional. Can be over-ridden with the command line parameter --bin-features | ||
bin-features = ["ssr"] | ||
|
||
# If the --no-default-features flag should be used when compiling the bin target | ||
# | ||
# Optional. Defaults to false. | ||
bin-default-features = false | ||
|
||
# The features to use when compiling the lib target | ||
# | ||
# Optional. Can be over-ridden with the command line parameter --lib-features | ||
lib-features = ["hydrate"] | ||
|
||
# If the --no-default-features flag should be used when compiling the lib target | ||
# | ||
# Optional. Defaults to false. | ||
lib-default-features = false | ||
|
||
# The profile to use for the lib target when compiling for release | ||
# | ||
# Optional. Defaults to "release". | ||
lib-profile-release = "wasm-release" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2022 henrik | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,86 @@ | ||
<picture> | ||
<source srcset="https://raw.githubusercontent.com/leptos-rs/leptos/main/docs/logos/Leptos_logo_Solid_White.svg" media="(prefers-color-scheme: dark)"> | ||
<img src="https://raw.githubusercontent.com/leptos-rs/leptos/main/docs/logos/Leptos_logo_RGB.svg" alt="Leptos Logo"> | ||
</picture> | ||
|
||
# Leptos Axum Starter Template | ||
|
||
This is a template for use with the [Leptos](https://github.com/leptos-rs/leptos) web framework and the [cargo-leptos](https://github.com/akesson/cargo-leptos) tool using [Axum](https://github.com/tokio-rs/axum). | ||
|
||
## Creating your template repo | ||
|
||
If you don't have `cargo-leptos` installed you can install it with | ||
|
||
```bash | ||
cargo install cargo-leptos | ||
``` | ||
|
||
Then run | ||
```bash | ||
cargo leptos new --git leptos-rs/start-axum | ||
``` | ||
|
||
to generate a new project template. | ||
|
||
```bash | ||
cd frontend | ||
``` | ||
|
||
to go to your newly created project. | ||
Feel free to explore the project structure, but the best place to start with your application code is in `src/app.rs`. | ||
Addtionally, Cargo.toml may need updating as new versions of the dependencies are released, especially if things are not working after a `cargo update`. | ||
|
||
## Running your project | ||
|
||
```bash | ||
cargo leptos watch | ||
``` | ||
|
||
## Installing Additional Tools | ||
|
||
By default, `cargo-leptos` uses `nightly` Rust, `cargo-generate`, and `sass`. If you run into any trouble, you may need to install one or more of these tools. | ||
|
||
1. `rustup toolchain install nightly --allow-downgrade` - make sure you have Rust nightly | ||
2. `rustup target add wasm32-unknown-unknown` - add the ability to compile Rust to WebAssembly | ||
3. `cargo install cargo-generate` - install `cargo-generate` binary (should be installed automatically in future) | ||
4. `npm install -g sass` - install `dart-sass` (should be optional in future | ||
|
||
## Compiling for Release | ||
```bash | ||
cargo leptos build --release | ||
``` | ||
|
||
Will generate your server binary in target/server/release and your site package in target/site | ||
|
||
## Testing Your Project | ||
```bash | ||
cargo leptos end-to-end | ||
``` | ||
|
||
```bash | ||
cargo leptos end-to-end --release | ||
``` | ||
|
||
Cargo-leptos uses Playwright as the end-to-end test tool. | ||
Tests are located in end2end/tests directory. | ||
|
||
## Executing a Server on a Remote Machine Without the Toolchain | ||
After running a `cargo leptos build --release` the minimum files needed are: | ||
|
||
1. The server binary located in `target/server/release` | ||
2. The `site` directory and all files within located in `target/site` | ||
|
||
Copy these files to your remote server. The directory structure should be: | ||
```text | ||
frontend | ||
site/ | ||
``` | ||
Set the following environment variables (updating for your project as needed): | ||
```text | ||
LEPTOS_OUTPUT_NAME="frontend" | ||
LEPTOS_SITE_ROOT="site" | ||
LEPTOS_SITE_PKG_DIR="pkg" | ||
LEPTOS_SITE_ADDR="127.0.0.1:3000" | ||
LEPTOS_RELOAD_PORT="3001" | ||
``` | ||
Finally, run the server binary. |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
{ | ||
"name": "end2end", | ||
"version": "1.0.0", | ||
"description": "", | ||
"main": "index.js", | ||
"scripts": {}, | ||
"keywords": [], | ||
"author": "", | ||
"license": "ISC", | ||
"devDependencies": { | ||
"@playwright/test": "^1.28.0" | ||
} | ||
} |
Oops, something went wrong.