Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/savenkovigor/qmlsandbox
https://github.com/savenkovigor/qmlsandbox
github-pages qml qt qt6 wasm
Last synced: 3 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/savenkovigor/qmlsandbox
- Owner: SavenkovIgor
- License: mit
- Created: 2023-06-17T17:08:27.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-06-18T11:18:40.000Z (over 1 year ago)
- Last Synced: 2024-12-19T13:12:39.598Z (about 2 months ago)
- Topics: github-pages, qml, qt, qt6, wasm
- Language: Python
- Homepage: https://savenkovigor.github.io/QmlSandbox/
- Size: 4.88 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# QmlSandbox: An Online QML Editor with Github Pages Deployment
Welcome to QmlSandbox, a dedicated online QML editor project built with C++/Qt. The project is designed to be easily deployed on Github Pages.
[](https://github.com/SavenkovIgor/QmlSandbox/actions/workflows/BuildDeploy.yml)
View a live demo of QmlSandbox in action here: [QmlSandbox](https://savenkovigor.github.io/QmlSandbox/). :warning: Please allow ~20 seconds for it to load the Qt libraries.
## Project structure
```bash
├── .github/workflows/BuildDeploy.yml # Github Actions workflow for build and deploy to Github Pages
├── CMakeLists.txt # CMake configuration file
├── CMakePresets.json # CMake presets file
├── main.cpp # Main cpp file that initializes the qml engine
├── main.qml # QML file containing the primary application interface
└── project.py # The main project script
```
## Getting Started
To get started with the QmlSandbox project, you can use the "Use this template" button located at the top of the repository. You will also need to activate Github Pages for your repository, using the Github actions way of deployment.
## Dependencies
- Cmake/Ninja
- Qt 6.5.1
- aqtinstall (script for qt installation. optional)
## :hammer_and_wrench: Build instructions
To build the QmlSandbox project, you can use a script
```bash
./project.py --install --build
```
or you can run commands from the script manually:
```bash
# Install dependencies
pip install aqtinstall
# Install Qt [optional if you already have Qt installed]
aqt install-qt linux desktop 6.5.1 gcc_64 --outputdir ./Qt
aqt install-qt linux desktop 6.5.1 wasm_32 --outputdir ./Qt
# Configure cmake
cmake --preset=wasm_release -Wno-dev
# Build the project
cmake --build --preset=wasm_release
# Upon completion, you will have a folder ready for deployment at
# ./build/wasm_release/deploy
```
## Contributing
We welcome and appreciate contributions! If you would like to contribute to QmlSandbox, please fork the repository and submit a pull request.