[refactor] Remove configuration files and assets

Cargo.toml

@@ -1,28 +1,16 @@
-[package]
-name = "tester"
-version = "0.1.0"
-authors = ["vikingowl <christian@nachtigall.dev>"]
-edition = "2021"
+[workspace]
+resolver = "2"
+members = [
+    "ui",
+    "web",
+    "desktop",
+    "mobile",
+    "api",
+]
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+[workspace.dependencies]
+dioxus = { version = "0.6.0" }
 
-[dependencies]
-dioxus = { version = "0.6.0", features = ["router", "fullstack"] }
-
-[features]
-default = ["web"]
-web = ["dioxus/web"]
-desktop = ["dioxus/desktop"]
-mobile = ["dioxus/mobile"]
-
-[profile]
-
-[profile.wasm-dev]
-inherits = "dev"
-opt-level = 1
-
-[profile.server-dev]
-inherits = "dev"
-
-[profile.android-dev]
-inherits = "dev"
+# workspace
+ui = { path = "ui" }
+api = { path = "api" }

Dioxus.toml

@@ -1,21 +0,0 @@
-[application]
-
-[web.app]
-
-# HTML title tag content
-title = "tester"
-
-# include `assets` in web platform
-[web.resource]
-
-# Additional CSS style files
-style = []
-
-# Additional JavaScript files
-script = []
-
-[web.resource.dev]
-
-# Javascript code file
-# serve: [dev-server] only
-script = []

README.md

@@ -1,34 +1,72 @@
 # Development
 
-Your new bare-bones project includes minimal organization with a single `main.rs` file and a few assets.
+Your new workspace contains a member crate for each of the web, desktop and mobile platforms, a `ui` crate for shared components and a `api` crate for shared backend logic:
 
 ```
-project/
-├─ assets/ # Any assets that are used by the app should be placed here
+your_project/
+├─ web/
+│  ├─ ... # Web specific UI/logic
+├─ desktop/
+│  ├─ ... # Desktop specific UI/logic
+├─ mobile/
+│  ├─ ... # Mobile specific UI/logic
+├─ api/
+│  ├─ ... # All shared server logic
+├─ ui/
+│  ├─ ... # Component shared between multiple platforms
+```
+
+## Platform crates
+
+Each platform crate contains the entry point for the platform, and any assets, components and dependencies that are specific to that platform. For example, the desktop crate in the workspace looks something like this:
+
+```
+desktop/ # The desktop crate contains all platform specific UI, logic and dependencies for the desktop app
+├─ assets/ # Assets used by the desktop app - Any platform specific assets should go in this folder
 ├─ src/
-│  ├─ main.rs # main.rs is the entry point to your application and currently contains all components for the app
-├─ Cargo.toml # The Cargo.toml file defines the dependencies and feature flags for your project
+│  ├─ main.rs # The entrypoint for the desktop app. It also defines the routes for the desktop platform
+│  ├─ views/ # The views each route will render in the desktop version of the app
+│  │  ├─ mod.rs # Defines the module for the views route and re-exports the components for each route
+│  │  ├─ blog.rs # The component that will render at the /blog/:id route
+│  │  ├─ home.rs # The component that will render at the / route
+├─ Cargo.toml # The desktop crate's Cargo.toml - This should include all desktop specific dependencies
 ```
 
-### Tailwind
-1. Install npm: https://docs.npmjs.com/downloading-and-installing-node-js-and-npm
-2. Install the Tailwind CSS CLI: https://tailwindcss.com/docs/installation
-3. Run the following command in the root of the project to start the Tailwind CSS compiler:
+When you start developing with the workspace setup each of the platform crates will look almost identical. The UI starts out exactly the same on all platforms. However, as you continue developing your application, this setup makes it easy to let the views for each platform change independently.
 
-```bash
-npx tailwindcss -i ./tailwind.css -o ./assets/tailwind.css --watch
+## Shared UI crate
+
+The workspace contains a `ui` crate with components that are shared between multiple platforms. You should put any UI elements you want to use in multiple platforms in this crate. You can also put some shared client side logic in this crate, but be careful to not pull in platform specific dependencies. The `ui` crate starts out something like this:
+
+```
+ui/
+├─ src/
+│  ├─ lib.rs # The entrypoint for the ui crate
+│  ├─ hero.rs # The Hero component that will be used in every platform
+│  ├─ echo.rs # The shared echo component that communicates with the server
+│  ├─ navbar.rs # The Navbar component that will be used in the layout of every platform's router
+```
+
+## Shared backend logic
+
+The workspace contains a `api` crate with shared backend logic. This crate defines all of the shared server functions for all platforms. Server functions are async functions that expose a public API on the server. They can be called like a normal async function from the client. When you run `dx serve`, all of the server functions will be collected in the server build and hosted on a public API for the client to call. The `api` crate starts out something like this:
+
+```
+api/
+├─ src/
+│  ├─ lib.rs # Exports a server function that echos the input string
 ```
 
 ### Serving Your App
 
-Run the following command in the root of your project to start developing with the default platform:
-
+Navigate to the platform crate of your choice:
 ```bash
-dx serve --platform web
+cd web
 ```
 
-To run for a different platform, use the `--platform platform` flag. E.g.
+and serve:
+
 ```bash
-dx serve --platform desktop
+dx serve
 ```
 

api/Cargo.toml

@@ -0,0 +1,7 @@
+[package]
+name = "api"
+version = "0.1.0"
+edition = "2021"
+
+[dependencies]
+dioxus = { workspace = true, features = ["fullstack"] }

api/README.md

@@ -0,0 +1,13 @@
+# API
+
+This crate contains all shared fullstack server functions. This is a great place to place any server-only logic you would like to expose in multiple platforms like a method that accesses your database or a method that sends an email.
+
+This crate will be built twice:
+1. Once for the server build with the `dioxus/server` feature enabled
+2. Once for the client build with the client feature disabled
+
+During the server build, the server functions will be collected and hosted on a public API for the client to call. During the client build, the server functions will be compiled into the client build.
+
+## Dependencies
+
+Most server dependencies (like sqlx and tokio) will not compile on client platforms like WASM. To avoid building server dependencies on the client, you should add platform specific dependencies under the `server` feature in the [Cargo.toml](../Cargo.toml) file. More details about managing server only dependencies can be found in the [Dioxus guide](https://dioxuslabs.com/learn/0.6/guides/fullstack/managing_dependencies#adding-server-only-dependencies).

api/src/lib.rs

@@ -0,0 +1,2 @@
+//! This crate contains all shared fullstack server functions.
+use dioxus::prelude::*;

assets/main.css

@@ -1,107 +0,0 @@
-/* App-wide styling */
-body {
-    background-color: #0f1116;
-    color: #ffffff;
-    font-family: 'Segoe UI', Tahoma, Geneva, Verdana, sans-serif;
-    margin: 20px;
-}
-
-#hero {
-    margin: 0;
-    display: flex;
-    flex-direction: column;
-    justify-content: center;
-    align-items: center;
-}
-
-#links {
-    width: 400px;
-    text-align: left;
-    font-size: x-large;
-    color: white;
-    display: flex;
-    flex-direction: column;
-}
-
-#links a {
-    color: white;
-    text-decoration: none;
-    margin-top: 20px;
-    margin: 10px 0px;
-    border: white 1px solid;
-    border-radius: 5px;
-    padding: 10px;
-}
-
-#links a:hover {
-    background-color: #1f1f1f;
-    cursor: pointer;
-}
-
-#header {
-    max-width: 1200px;
-}
-
-/* Navbar */
-#navbar {
-    display: flex;
-    flex-direction: row;
-  }
-  
-#navbar a {
-    color: #ffffff;
-    margin-right: 20px;
-    text-decoration: none;
-    transition: color 0.2s ease;
-}
-
-#navbar a:hover {
-    cursor: pointer;
-    color: #91a4d2;
-}
-
-/* Blog page */
-#blog {
-    margin-top: 50px;
-  }
-  
-#blog a {
-    color: #ffffff;
-    margin-top: 50px;
-}
-
-/* Echo */
-#echo {
-    width: 360px;
-    margin-left: auto;
-    margin-right: auto;
-    margin-top: 50px;
-    background-color: #1e222d;
-    padding: 20px;
-    border-radius: 10px;
-}
-
-#echo>h4 {
-    margin: 0px 0px 15px 0px;
-}
-
-
-#echo>input {
-    border: none;
-    border-bottom: 1px white solid;
-    background-color: transparent;
-    color: #ffffff;
-    transition: border-bottom-color 0.2s ease;
-    outline: none;
-    display: block;
-    padding: 0px 0px 5px 0px;
-    width: 100%;
-}
-
-#echo>input:focus {
-    border-bottom-color: #6d85c6;
-}
-
-#echo>p {
-    margin: 20px 0px 0px auto;
-}

desktop/Cargo.toml

@@ -0,0 +1,13 @@
+[package]
+name = "desktop"
+version = "0.1.0"
+edition = "2021"
+
+[dependencies]
+dioxus = { workspace = true, features = ["router"] }
+ui = { workspace = true }
+
+[features]
+default = []
+desktop = ["dioxus/desktop"]
+server = ["dioxus/server"]

desktop/README.md

@@ -0,0 +1,30 @@
+# Development
+
+The desktop crate defines the entrypoint for the desktop app along with any assets, components and dependencies that are specific to desktop builds. The desktop crate starts out something like this:
+
+```
+desktop/
+├─ assets/ # Assets used by the desktop app - Any platform specific assets should go in this folder
+├─ src/
+│  ├─ main.rs # The entrypoint for the desktop app.It also defines the routes for the desktop platform
+│  ├─ views/ # The views each route will render in the desktop version of the app
+│  │  ├─ mod.rs # Defines the module for the views route and re-exports the components for each route
+│  │  ├─ blog.rs # The component that will render at the /blog/:id route
+│  │  ├─ home.rs # The component that will render at the / route
+├─ Cargo.toml # The desktop crate's Cargo.toml - This should include all desktop specific dependencies
+```
+
+## Dependencies
+Since you have fullstack enabled, the desktop crate will be built two times:
+1. Once for the server build with the `server` feature enabled
+2. Once for the client build with the `desktop` feature enabled
+
+You should make all desktop specific dependencies optional and only enabled in the `desktop` feature. This will ensure that the server builds don't pull in desktop specific dependencies which cuts down on build times significantly.
+
+### Serving Your Desktop App
+
+You can start your desktop app with the following command:
+
+```bash
+dx serve
+```

desktop/assets/main.css

@@ -0,0 +1,6 @@
+body {
+    background-color: #0f1116;
+    color: #ffffff;
+    font-family: 'Segoe UI', Tahoma, Geneva, Verdana, sans-serif;
+    margin: 20px;
+}

desktop/src/main.rs

@@ -0,0 +1,17 @@
+use dioxus::prelude::*;
+
+const MAIN_CSS: Asset = asset!("/assets/main.css");
+
+fn main() {
+    dioxus::launch(App);
+}
+
+#[component]
+fn App() -> Element {
+    // Build cool things ✌️
+
+    rsx! {
+        // Global app resources
+        document::Link { rel: "stylesheet", href: MAIN_CSS }
+    }
+}

mobile/Cargo.toml

@@ -0,0 +1,13 @@
+[package]
+name = "mobile"
+version = "0.1.0"
+edition = "2021"
+
+[dependencies]
+dioxus = { workspace = true, features = ["router"] }
+ui = { workspace = true }
+
+[features]
+default = []
+mobile = ["dioxus/mobile"]
+server = ["dioxus/server"]

mobile/README.md

@@ -0,0 +1,30 @@
+# Development
+
+The mobile crate defines the entrypoint for the mobile app along with any assets, components and dependencies that are specific to mobile builds. The mobile crate starts out something like this:
+
+```
+mobile/
+├─ assets/ # Assets used by the mobile app - Any platform specific assets should go in this folder
+├─ src/
+│  ├─ main.rs # The entrypoint for the mobile app.It also defines the routes for the mobile platform
+│  ├─ views/ # The views each route will render in the mobile version of the app
+│  │  ├─ mod.rs # Defines the module for the views route and re-exports the components for each route
+│  │  ├─ blog.rs # The component that will render at the /blog/:id route
+│  │  ├─ home.rs # The component that will render at the / route
+├─ Cargo.toml # The mobile crate's Cargo.toml - This should include all mobile specific dependencies
+```
+
+## Dependencies
+Since you have fullstack enabled, the mobile crate will be built two times:
+1. Once for the server build with the `server` feature enabled
+2. Once for the client build with the `mobile` feature enabled
+
+You should make all mobile specific dependencies optional and only enabled in the `mobile` feature. This will ensure that the server builds don't pull in mobile specific dependencies which cuts down on build times significantly.
+
+### Serving Your Mobile App
+
+Mobile platforms are shared in a single crate. To serve mobile, you need to explicitly set your target device to `android` or `ios`:
+
+```bash
+dx serve --platform android
+```

mobile/assets/main.css

@@ -0,0 +1,6 @@
+body {
+    background-color: #0f1116;
+    color: #ffffff;
+    font-family: 'Segoe UI', Tahoma, Geneva, Verdana, sans-serif;
+    margin: 20px;
+}

mobile/src/main.rs

@@ -0,0 +1,17 @@
+use dioxus::prelude::*;
+
+const MAIN_CSS: Asset = asset!("/assets/main.css");
+
+fn main() {
+    dioxus::launch(App);
+}
+
+#[component]
+fn App() -> Element {
+    // Build cool things ✌️
+
+    rsx! {
+        // Global app resources
+        document::Link { rel: "stylesheet", href: MAIN_CSS }
+    }
+}

src/main.rs

@@ -1,134 +0,0 @@
-use dioxus::prelude::*;
-
-#[derive(Debug, Clone, Routable, PartialEq)]
-#[rustfmt::skip]
-enum Route {
-    #[layout(Navbar)]
-    #[route("/")]
-    Home {},
-    #[route("/blog/:id")]
-    Blog { id: i32 },
-}
-
-const FAVICON: Asset = asset!("/assets/favicon.ico");
-const MAIN_CSS: Asset = asset!("/assets/main.css");
-const HEADER_SVG: Asset = asset!("/assets/header.svg");
-const TAILWIND_CSS: Asset = asset!("/assets/tailwind.css");
-
-fn main() {
-    dioxus::launch(App);
-}
-
-#[component]
-fn App() -> Element {
-    rsx! {
-        document::Link { rel: "icon", href: FAVICON }
-        document::Link { rel: "stylesheet", href: MAIN_CSS } document::Link { rel: "stylesheet", href: TAILWIND_CSS }
-        Router::<Route> {}
-    }
-}
-
-#[component]
-pub fn Hero() -> Element {
-    rsx! {
-        div {
-            id: "hero",
-            img { src: HEADER_SVG, id: "header" }
-            div { id: "links",
-                a { href: "https://dioxuslabs.com/learn/0.6/", "📚 Learn Dioxus" }
-                a { href: "https://dioxuslabs.com/awesome", "🚀 Awesome Dioxus" }
-                a { href: "https://github.com/dioxus-community/", "📡 Community Libraries" }
-                a { href: "https://github.com/DioxusLabs/sdk", "⚙️ Dioxus Development Kit" }
-                a { href: "https://marketplace.visualstudio.com/items?itemName=DioxusLabs.dioxus", "💫 VSCode Extension" }
-                a { href: "https://discord.gg/XgGxMSkvUM", "👋 Community Discord" }
-            }
-        }
-    }
-}
-
-/// Home page
-#[component]
-fn Home() -> Element {
-    rsx! {
-        Hero {}
-        Echo {}
-    }
-}
-
-/// Blog page
-#[component]
-pub fn Blog(id: i32) -> Element {
-    rsx! {
-        div {
-            id: "blog",
-
-            // Content
-            h1 { "This is blog #{id}!" }
-            p { "In blog #{id}, we show how the Dioxus router works and how URL parameters can be passed as props to our route components." }
-
-            // Navigation links
-            Link {
-                to: Route::Blog { id: id - 1 },
-                "Previous"
-            }
-            span { " <---> " }
-            Link {
-                to: Route::Blog { id: id + 1 },
-                "Next"
-            }
-        }
-    }
-}
-
-/// Shared navbar component.
-#[component]
-fn Navbar() -> Element {
-    rsx! {
-        div {
-            id: "navbar",
-            Link {
-                to: Route::Home {},
-                "Home"
-            }
-            Link {
-                to: Route::Blog { id: 1 },
-                "Blog"
-            }
-        }
-
-        Outlet::<Route> {}
-    }
-}
-
-/// Echo component that demonstrates fullstack server functions.
-#[component]
-fn Echo() -> Element {
-    let mut response = use_signal(|| String::new());
-
-    rsx! {
-        div {
-            id: "echo",
-            h4 { "ServerFn Echo" }
-            input {
-                placeholder: "Type here to echo...",
-                oninput:  move |event| async move {
-                    let data = echo_server(event.value()).await.unwrap();
-                    response.set(data);
-                },
-            }
-
-            if !response().is_empty() {
-                p {
-                    "Server echoed: "
-                    i { "{response}" }
-                }
-            }
-        }
-    }
-}
-
-/// Echo the user input on the server.
-#[server(EchoServer)]
-async fn echo_server(input: String) -> Result<String, ServerFnError> {
-    Ok(input)
-}

tailwind.config.js

@@ -1,9 +0,0 @@
-/** @type {import('tailwindcss').Config} */
-module.exports = {
-  mode: "all",
-  content: ["./src/**/*.{rs,html,css}", "./dist/**/*.html"],
-  theme: {
-    extend: {},
-  },
-  plugins: [],
-};

tailwind.css

@@ -1,3 +0,0 @@
-@tailwind base;
-@tailwind components;
-@tailwind utilities;

ui/Cargo.toml

@@ -0,0 +1,8 @@
+[package]
+name = "ui"
+version = "0.1.0"
+edition = "2021"
+
+[dependencies]
+dioxus = { workspace = true }
+api = { workspace = true }

ui/README.md

@@ -0,0 +1,16 @@
+# UI
+
+This crate contains all shared components for the workspace. This is a great place to place any UI you would like to use in multiple platforms like a common `Button` or `Navbar` component.
+
+```
+ui/
+├─ src/
+│  ├─ lib.rs # The entrypoint for the ui crate
+│  ├─ hero.rs # The Hero component that will be used in every platform
+│  ├─ echo.rs # The shared echo component that communicates with the server
+│  ├─ navbar.rs # The Navbar component that will be used in the layout of every platform's router
+```
+
+## Dependencies
+
+Since this crate is shared between multiple platforms, it should not pull in any platform specific dependencies. For example, if you want to use the `web_sys` crate in the web build of your app, you should not add it to this crate. Instead, you should add platform specific dependencies to the [web](../web/Cargo.toml), [desktop](../desktop/Cargo.toml), or [mobile](../mobile/Cargo.toml) crates.

ui/src/lib.rs

@@ -0,0 +1 @@
+//! This crate contains all shared UI for the workspace.

web/Cargo.toml

@@ -0,0 +1,13 @@
+[package]
+name = "web"
+version = "0.1.0"
+edition = "2021"
+
+[dependencies]
+dioxus = { workspace = true, features = ["router"] }
+ui = { workspace = true }
+
+[features]
+default = []
+web = ["dioxus/web"]
+server = ["dioxus/server"]

web/README.md

@@ -0,0 +1,30 @@
+# Development
+
+The web crate defines the entrypoint for the web app along with any assets, components and dependencies that are specific to web builds. The web crate starts out something like this:
+
+```
+web/
+├─ assets/ # Assets used by the web app - Any platform specific assets should go in this folder
+├─ src/
+│  ├─ main.rs # The entrypoint for the web app.It also defines the routes for the web platform
+│  ├─ views/ # The views each route will render in the web version of the app
+│  │  ├─ mod.rs # Defines the module for the views route and re-exports the components for each route
+│  │  ├─ blog.rs # The component that will render at the /blog/:id route
+│  │  ├─ home.rs # The component that will render at the / route
+├─ Cargo.toml # The web crate's Cargo.toml - This should include all web specific dependencies
+```
+
+## Dependencies
+Since you have fullstack enabled, the web crate will be built two times:
+1. Once for the server build with the `server` feature enabled
+2. Once for the client build with the `web` feature enabled
+
+You should make all web specific dependencies optional and only enabled in the `web` feature. This will ensure that the server builds don't pull in web specific dependencies which cuts down on build times significantly.
+
+### Serving Your Web App
+
+You can start your web app with the following command:
+
+```bash
+dx serve
+```

web/assets/main.css

@@ -0,0 +1,6 @@
+body {
+    background-color: #0f1116;
+    color: #ffffff;
+    font-family: 'Segoe UI', Tahoma, Geneva, Verdana, sans-serif;
+    margin: 20px;
+}

web/src/main.rs

@@ -0,0 +1,17 @@
+use dioxus::prelude::*;
+
+const MAIN_CSS: Asset = asset!("/assets/main.css");
+
+fn main() {
+    dioxus::launch(App);
+}
+
+#[component]
+fn App() -> Element {
+    // Build cool things ✌️
+
+    rsx! {
+        // Global app resources
+        document::Link { rel: "stylesheet", href: MAIN_CSS }
+    }
+}