https://github.com/gtamas/schematicsgui
GUI builder generator for Schematics projects
https://github.com/gtamas/schematicsgui
gtk4 gui rust schematics
Last synced: 5 months ago
JSON representation
GUI builder generator for Schematics projects
- Host: GitHub
- URL: https://github.com/gtamas/schematicsgui
- Owner: gtamas
- License: mit
- Created: 2023-09-17T21:59:10.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-03-05T17:06:04.000Z (over 2 years ago)
- Last Synced: 2024-04-20T18:53:21.716Z (about 2 years ago)
- Topics: gtk4, gui, rust, schematics
- Language: Rust
- Homepage:
- Size: 6.45 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Schematics UI
* 1. [What is this project about?](#Whatisthisprojectabout)
* 2. [A word of warning](#Awordofwarning)
* 3. [What do you need to use this?](#Whatdoyouneedtousethis)
* 4. [Getting started](#Gettingstarted)
* 5. [Providing feedback, asking for help, reporting bugs](#Providingfeedbackaskingforhelpreportingbugs)
## 1. What is this project about?
This app aims to be a GUI generator for any software based on Google's [Schematics](https://angular.io/guide/schematics) library.
Schematics provides only CLI support by default. Schematics UI can automatically generate a fully native and easy to use [GKT4](https://www.gtk.org/) GUI for any schematic. This GUI is entirely based on the JSON schema of the schematic, so it should work with any package out there.
The generated GUI is highly customizable and this requires only some JSON schema extension, so the CLI shouldn't be affected.
Furthermore, the app also provides all the tools you need to work with schematics. You may browse contents of any schematics package, sync frequently used settings to disk creating different profiles for each schematic, reload, update or clone these profiles and of course you may also execute any schematic right from GUI.
It's a native app, written in Rust, uses [Relm4](https://relm4.org/) and [GTK-rs](https://gtk-rs.org/) rust bindings and it's gonna be available for OSX, Windows and Linux.
This is still a work in progress. Although it should work fine with any schematics package, it was only tested with FND and NestJS so far. The app is not released yet and it's **NOT** production-ready. Currently, an alpha version is available. Use it at your own risk.
## 3. What do you need to use this?
This is NOT a Schematics engine! It's just a GUI generator which can build UI for any schematic and execute that schematic using CLI. In order to use this, you need something like Google's [Schematics CLI](https://www.npmjs.com/package/@angular-devkit/schematics-cli) or another schematics implementation.
Once you've installed that, you are good to go.
First, you should install the app. There are to ways to do that:
- Visit the [release page](https://github.com/gtamas/schematicsgui/releases) and grab a pre-built binary. This is the easiest and recommended way. Currently only an alpha version is available and only for OSX.
- Optionally, you can also build the app from source. This is the only way right now if you are not using a Mac. Please see the [build page](./BUILD.md) for more info.
Once you have the app installed, you can:
- Check out the [Usage page](./USAGE.md) for general setup and usage instructions.
- See the [UI page](./UI.md) to learn more about the generated UI and the available customization options.
## 5. Providing feedback, asking for help, reporting bugs
- Bugs and issues should be reported via our [issue tracker](https://github.com/gtamas/schematicsgui/issues)
- New features should be requested [here](https://github.com/gtamas/schematicsgui/issues/new?assignees=&labels=help+wanted&projects=&template=feature_request.md&title=%5BFEATURE%5D).
- Contact the author or ask for help by starting a [discussion](https://github.com/gtamas/schematicsgui/discussions).
Thanks and have fun!