Skip to content

microgui/MicroGUI

Repository files navigation

Contributors Forks Stargazers Issues MIT License


Logo

MicroGUI

An open-source tool for creating embedded GUIs!
Explore the docs »

Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Contributing
  5. License
  6. Contact
  7. Acknowledgments

About The Project

Use the MicroGUI web application to create simple GUIs using ready-made components! Components include buttons, switches, sliders and textfields (more to come!).

(back to top)

Architecture

(back to top)

Getting Started

Prerequisites

Download Node.js.

Get the latest NPM version.

  • npm
    npm install npm@latest -g

Installation

  1. Clone the repository
    git clone https://github.com/microgui/MicroGUI.git
  2. Change directory to MicroGUI
    cd your_repo_location/MicroGUI
  3. Install NPM packages
    npm install
  4. Run the app
    npm start
  5. Open the app
    Go to localhost:3000 in the browser

(back to top)

Usage

Drag any component onto the canvas area and start moving it around freely, or edit its appearance. You can choose to "simulate" the current state of the canvas area, which removes the ability to move and edit components. You can also save the state of the canvas area by copying to clipboard or downloading a file.

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Carl Classon - [email protected]

William Husar - [email protected]

(back to top)

Acknowledgments

Helpful resources

A big thanks to @othneildrew for the README template.

(back to top)