Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/makepad/makepad
Makepad is a creative software development platform for Rust that compiles to wasm/webGL, osx/metal, windows/dx11 linux/opengl
https://github.com/makepad/makepad
Last synced: 26 days ago
JSON representation
Makepad is a creative software development platform for Rust that compiles to wasm/webGL, osx/metal, windows/dx11 linux/opengl
- Host: GitHub
- URL: https://github.com/makepad/makepad
- Owner: makepad
- License: mit
- Created: 2019-02-20T11:54:00.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-06-20T11:43:13.000Z (5 months ago)
- Last Synced: 2024-06-21T20:38:04.333Z (5 months ago)
- Language: WebAssembly
- Homepage: http://makepad.dev/
- Size: 62.3 MB
- Stars: 4,914
- Watchers: 90
- Forks: 233
- Open Issues: 56
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-game-engine-dev - Makepad - Software development platform and native-rendering gui framework. [[Editor](https://makepad.dev/)] (Libraries / Rust)
- awesome-rust - makepad/makepad - widgets](https://crates.io/crates/makepad-widgets)] — Makepad is a creative software development platform that compiles to wasm/webGL, osx/metal, windows/dx11 linux/opengl. (Libraries / GUI)
- awesome-starred - makepad/makepad - Makepad is a creative software development platform for Rust that compiles to wasm/webGL, osx/metal, windows/dx11 linux/opengl (others)
- awesome-rust-list - Makepad
- awesome-rust-list - Makepad
- awesome-github-repos - makepad/makepad - Makepad is a creative software development platform for Rust that compiles to wasm/webGL, osx/metal, windows/dx11 linux/opengl (Rust)
README
## Contact
Rik Arends: @rikarends on twitter, https://fosstodon.org/@rikarends#
Eddy Bruel: @ejpbruel on twitter
Sebastian Michailidis: @SebMichailidis on twitter
Our discord channel for Makepad:
https://discord.gg/adqBRq7Ece
Most recent talk about makepad: https://www.youtube.com/watch?v=rC4FCS-oMpg
# Makepad
## Overview
This is the repository for Makepad, a new way to build UIs in Rust for both native and the web.
Makepad consists of Makepad Framework and Makepad Studio.
Makepad Framework is our UI framework. It consists of multiple crates, but the top level crate is [makepad-widgets](https://crates.io/crates/makepad-widgets). For a further explanation of Makepad Framework, please see the README for that crate.
Makepad Studio is a prototype of an IDE that we've built using Makepad Framework. It's still under heavy development, but our eventual goal with Makepad Studio is to create an IDE that enables the design of an application to be changed at runtime. The main crate for Makepad Studio is [makepad-studio](https://crates.io/crates/makepad-studio). Please see the README for that crate for more.
Demo links:
[makepad-example-fractal-zoom](https://makepad.nl/makepad/examples/fractal_zoom/src/index.html)
[makepad-example-ironfish](https://makepad.nl/makepad/examples/ironfish/src/index.html)
[makepad-example-simple](https://makepad.nl/makepad/examples/simple/src/index.html)
### Prerequisites
To build the Makepad crates you first need to install Rust.
[https://www.rust-lang.org/tools/install](https://www.rust-lang.org/tools/install)
Our native builds work on the stable Rust toolchain. However, some of the errors generated by Makepad at runtime (particulary those originating in our DSL) do not contain line information unless you use the nightly Rust toolchain. Moreover, our web builds only work on nightly for now. For this reason, we recommend that you build Makepad using the nightly Rust toolchain.
For the non standard build targets (apple ios, apple tvos, android, wasm) we have a buildtool called 'cargo-makepad' that you need to install.
Install it from the repo:
```cargo install --path=./tools/cargo_makepad```
Or install it from cargo (might be behind the repo)
```cargo install cargo-makepad```
Now this tool can be used to install toolchains per platform needed
```cargo makepad wasm install-toolchain```
```cargo makepad apple ios install-toolchain```
```cargo makepad apple tvos install-toolchain```
```cargo makepad android --abi=all install-toolchain```
## Running makepad studio
Makepad studio allows you to easily build and view the examples, and it uses cargo-makepad internally so be sure to install cargo-makepad as shown above.
```cargo run -p makepad-studio --release```
Or install it from cargo (might be behind the repo)
```cargo install makepad-studio```
If you build the wasm applications, you can open it on:
## Build & Run Commands
[Makepad](https://github.com/makepad/makepad) is a cross-platform UI framework written in Rust.
It is in active development, but is already usable to build quick prototypes and simple (or even complicated UI) applications.
One of the key features of the Makepad is its ability to simply, and quickly, build and run applications on multiple platforms, including MacOS, Windows, Linux, Android, iOS, and WebAssembly.
Here are the current/latest instructions on how to build and run Makepad applications on the different platforms.
## Assumptions
We will assume the following:
Name of application: **`makepad-example-simple`**
It can be changed to any one of the existing example apps in the [*Makepad* examples folder](https://github.com/makepad/makepad//tree/master/examples).
## Build & Run Instructions
Follow step 1 commands below for initial setup of the Makepad build and run environment.
After step 2, you may choose any one or more of the platforms you're interested in building for.
## 1. Setup Makepad
Replace `projects` with your own directory name.
```bash
cd ~/projects
```
### Clone the Makepad repository
```bash
git clone https://github.com/makepad/makepad.git
```
or
```bash
git clone [email protected]:makepad/makepad.git
```
### Change to latest 'rik' branch (Optional)
```bash
cd ~/projects/makepad
git branch rik
```
### Install makepad subcommand for cargo
```bash
cd ~/projects/makepad
cargo install --path ./tools/cargo_makepad
```
### Install platform toolchains
```bash
rustup toolchain install nightly
```
## 2. Go To Examples folder (Optional)
```bash
cd ~/projects/makepad/examples
ls -l
```
All examples in this directory have the application name of `makepad-example-` prefix plus the name of directory.
## 3. MacOS / PC
Running on Desktop is the quickest way to try out an example app.
```bash
cd ~/projects/makepad/examples/simple
cargo run
```
or
```bash
cd ~/projects/makepad
cargo run -p makepad-example-simple
```
And there should be a desktop application window now running (may need to click on the icon on MacOS's Dock to show it)
## 4. Android Build
### Install Android toolchain (First time)
```bash
cargo makepad android install-toolchain
```
### Install app on Android device or Android emulator
Open either the Android emulator or connect to a real Android device
use `adb` command to make sure there's a single device connected properly, then install and run as below:
```bash
cd ~/projects/makepad
cargo makepad android run -p makepad-example-simple --release
```
The application will be installed and launch on either the emulator or device.
## 5. iOS Setup & Install
### Install iOS toolchain (First time)
```bash
xcode-select --install
cargo makepad apple ios install-toolchain
```
### Install app on Apple devivce or iOS simulator
### iOS Setup
For iOS, the process is slightly more complicated. The steps involved are:
1. Enable your iPhone's Developer Mode, please see instructions here: [Enable Developer Mode](https://www.delasign.com/blog/how-to-turn-on-developer-mode-on-an-iphone/)
1. Setup an Apple Developer account
1. Setup an empty skeleton project in XCode
1. File -> New -> Project to create a new "App"
1. Set the Product Name as **`makepad-example-simple`** (used in --app later)
1. Set the Organization Identifier to a value of your choice, for this example we will use **`my.test`** (used in --org later)
1. Setup the Project Signing & Capabilities to select the proper team account
1. In XCode, Build/Run this project to install and run the app on the simulator and device
1. Once the simulator and device has the "skeleton" app installed and running properly, then it is ready for Makepad to install its application.
### Makepad Install
We will run the `cargo makepad apple ios` command, similar to Android build above, but there are some 2 to 6 additional parameters that need to be filled in:
**`--org`**
First few parts of the organization identifier. Usually in the form of *com.somecompany* or *org.orgname*, etc.
This is the same value used to setup the initial skeleton app above. For this example:
> `my.test`
**`--app`**
The name of the application or the project. This is the same as the Product Name used to setup the initial skeleton app above. In this case:
> `makepad-example-simple`
### Install app on iOS simulator
```bash
cd ~/projects/makepad
cargo makepad apple ios \
--org=my.test \
--app=makepad-example-simple \
run-sim -p makepad-example-simple --release
```
### Install app on iOS device
For installing on real device, the process is more involved due to possibility of multiple profiles and signing identities and target devices. For this reason, Makepad provides a list command to show all the local provisioning profiles, signing identities and connected devices, which can be used as the value for the subsequent command arguments.
For example, first run the following command:
```bash
cd ~/projects/makepad
cargo makepad apple list
```
This command will print out the list of all provisioning profiles, signing identities, and device identifiers on the current system. The user has to decide and choose the ones that he/she needs to use for each type.
Once decided, run the folloiwng command and fill in the **unique starting characters** chosen from the output.
```bash
cargo makepad apple ios \
--profile=unique-starting-hex-string-of-provisioning-profiles \
--cert=UNIQUE_STARTING_HEX_STRING-of-signing-certificates \
--device-identifier=UNIQUE-STARTING-HEX-STRING-of-devices \
--org=my.test \
--app=makepad-example-simple \
run-device -p makepad-example-simple –release
```
The application will be installed and launched on either the emulator or real device. (Make sure the device is connected and unlocked)
## 6. WASM Build
Running the Makepad application as a WASM build is as simple as a single command. The sript will automatically generate the necessary index.html and other files and also start a local webserver at port 8010. After running the command below, just open your browser to in order for the app to load and run.
### Install WASM toolchain (First time)
```bash
cargo makepad wasm install-toolchain
```
### Install app as WASM binary for browsers
```bash
cargo makepad wasm run -p makepad-example-simple --release
```
---
## Makepad Commands Quick Reference
### Cargo Tools Installations
These are commands that need to be run at least once initially to setup Makepad development environments.
They should also be run once in a while or when there are updates to the cargo_makepad script.
```bash
rustup update
rustup install nightly
rustup toolchain install nightly
cd ~/projects/makepad
cargo install --path ./tools/cargo_makepad
cargo makepad android install-toolchain
cargo makepad apple ios install-toolchain
cargo makepad apple tv install-toolchain
cargo makepad wasm install-toolchain
```
### Android
Command for installing the app onto an iOS Simulator.
```bash
cargo makepad android run -p makepad-example-simple --release
cargo makepad android run -p makepad-example-fractal-zoom --release
cargo makepad android run -p makepad-example-ironfish --release
cargo makepad android run -p makepad-example-news-feed --release
```
### iOS Simulator
Command for installing the app onto an iOS Simulator.
```bash
cargo makepad apple ios --org=my.test --app=makepad-example-simple run-sim -p makepad-example-simple --release
cargo makepad apple ios --org=my.test --app=makepad-example-fractal-zoom run-sim -p makepad-example-fractal-zoom --release
cargo makepad apple ios --org=my.test --app=makepad-example-ironfish run-sim -p makepad-example-ironfish --release
cargo makepad apple ios --org=my.test --app=makepad-example-news-feed run-sim -p makepad-example-news-feed --release
```
### iOS Device
Command for installing the app onto a physical iOS device.
**See Step 5 above for more detailed instructions.**
```bash
cargo makepad apple ios --org=my.test --profile=ABC --cert=DEF --device=MyiPhone --app=makepad-example-simple run-device -p makepad-example-simple --release
cargo makepad apple ios --org=my.test --profile=ABC --cert=DEF --device=MyiPhone --app=makepad-example-fractal-zoom run-device -p makepad-example-fractal-zoom --release
cargo makepad apple ios --org=my.test --profile=ABC --cert=DEF --device=MyiPhone --app=makepad-example-ironfish -run-device -p makepad-example-ironfish --release
cargo makepad apple ios --org=my.test --profile=ABC --cert=DEF --device=MyiPhone --app=makepad-example-news-feed run-device -p makepad-example-news-feed --release
```
### Cargo Check Builds
Command to check that the compilation passes for all Makepad supported platforms:
(Will use 100% CPU and cause hang machine, only try on high-end systems)
```bash
cargo makepad check install-toolchain
cargo makepad check all
```