Instant Compose
Start building your Compose app within a minute using any editor, share it on GitHub minutes later.
Quick Start
Parts of the video are sped up. Real time to first build takes about 40 seconds.
Share with colleagues
Automatically host your app on GitHub Pages and receive previews for each PR.
Get Started
1
Install the CLI
curl -fsSL https://emilflach.github.io/instant-compose/get.sh | bash
2
Create your app
compose init myApp
3
Run your app
cd myApp compose dev
Troubleshooting
A
Missing
curl?
apt-get update && apt-get install curl
B
Refresh Terminal
source ~/.bashrcor
source ~/.zshrc
Share with colleagues
1
Push your project to a public GitHub repository
2
Wait 10-15 minutes for the GitHub action to complete
3
Open the
Settings > Pages of your GitHub repository
4
Select the
gh-pages branch in the list and press Save
5
Wait 5 minutes for the GitHub action to complete
6
Your app is now live!
It will be available at <your_username>.github.io/<your_repo_name>
7
Optional: Create a PR
Receive a preview link as a comment on every Pull Request.
