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
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. 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. Please see the README for that crate for more.
Demo links:
To build the Makepad crates you first need to install Rust. 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
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:
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.
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.
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.
Replace projects with your own directory name.
cd ~/projectsgit clone https://github.com/makepad/makepad.gitor
git clone git@github.com:makepad/makepad.gitcd ~/projects/makepad
git branch rikcd ~/projects/makepad
cargo install --path ./tools/cargo_makepadrustup toolchain install nightlycd ~/projects/makepad/examples
ls -lAll examples in this directory have the application name of makepad-example- prefix plus the name of directory.
Running on Desktop is the quickest way to try out an example app.
cd ~/projects/makepad/examples/simple
cargo runor
cd ~/projects/makepad
cargo run -p makepad-example-simpleAnd there should be a desktop application window now running (may need to click on the icon on MacOS's Dock to show it)
cargo makepad android install-toolchainOpen 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:
cd ~/projects/makepad
cargo makepad android run -p makepad-example-simple --releaseThe application will be installed and launch on either the emulator or device.
xcode-select --install
cargo makepad apple ios install-toolchainFor iOS, the process is slightly more complicated. The steps involved are:
- Enable your iPhone's Developer Mode, please see instructions here: Enable Developer Mode
- Setup an Apple Developer account
- Setup an empty skeleton project in XCode
- File -> New -> Project to create a new "App"
- Set the Product Name as
makepad-example-simple(used in --app later) - Set the Organization Identifier to a value of your choice, for this example we will use
my.test(used in --org later) - Setup the Project Signing & Capabilities to select the proper team account
- In XCode, Build/Run this project to install and run the app on the simulator and device
- Once the simulator and device has the "skeleton" app installed and running properly, then it is ready for Makepad to install its application.
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
cd ~/projects/makepad
cargo makepad apple ios \
--org=my.test \
--app=makepad-example-simple \
run-sim -p makepad-example-simple --releaseFor 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:
cd ~/projects/makepad
cargo makepad apple listThis 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.
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)
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 http://127.0.0.1:8010/ in order for the app to load and run.
cargo makepad wasm install-toolchaincargo makepad wasm run -p makepad-example-simple --releaseThese 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.
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
Command for installing the app onto an iOS Simulator.
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 --releaseCommand for installing the app onto an iOS Simulator.
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 --releaseCommand for installing the app onto a physical iOS device.
See Step 5 above for more detailed instructions.
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 --releaseCommand 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)
cargo makepad check install-toolchain
cargo makepad check all