Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sikessem/ux

:lipstick: Interactive User Interface Kit
https://github.com/sikessem/ux

interactive-user-interface iui iui-kit kit ui ui-components ui-kit uikit user-interface

Last synced: about 2 months ago
JSON representation

:lipstick: Interactive User Interface Kit

Awesome Lists containing this project

README

        


SIKessEm logo



SIKessEm Package is released under the MIT license.
GitHub Workflow Status (main)
Total Downloads
Latest Version
PRs welcome!
Follow @ske_sikessem


***

# πŸ’„ Interactive User Interface Kit

Design interactive user interfaces in HTML, CSS and JavaScript from PHP scripts.

### πŸ”– Contents

- [Getting Started](#-getting-started)
- [Requirements](#-requirements)
- [Documentation](#-documentation)
- [Community](#-community)
- [Security Reports](#-security-reports)
- [Contribution](#-contribution)
- [License](#-license)

## πŸŽ‰ Getting Started

⚑️ Install [iui-kit](https://github.com/sikessem/iui-kit) using [Composer](https://getcomposer.org/):
- By adding the `iui/kit` dependency to your `composer.json` file:
```json
{
"require" : {
"iui/kit": "^0.1"
},
}
```
- Or by including the dependency:
```bash
composer require sikessem/iui-kit --no-dev
```
- Or by creating a new project from the template:
```bash
create-project sikessem/iui-kit --prefer-source iui-kit
```

🧹 Keep a modern codebase with **Pint**:
```bash
composer lint
```

βš—οΈ Run static analysis using **PHPStan**:
```bash
composer test:types
```

βœ… Run unit tests using **PEST**
```bash
composer test:unit
```

πŸš€ Run the entire test suite:
```bash
composer test
```

## πŸ“‹ Requirements

> **Requires [PHP 8.1+](https://php.net/releases/)** (at least 8.1.11 recommended to avoid potential bugs).

## πŸ“– Documentation

The full documentation for SIKessEm Packages can be found on [our SIKessEm Documentation][docs].

[docs]: https://sikessem.github.io/iui-kit

## πŸ’¬ Community

For support, you can use [our GitHub Discussions](https://github.com/sikessem/iui-kit/discussions).

## πŸ‘₯ Contribution

Read [our contributing guide][c] to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to Package.

[c]: https://github.com/sikessem/iui-kit/blob/HEAD/CONTRIBUTING.md

## πŸ” Security Reports

If you discover a security vulnerability within Package, please send an e-mail to [SIGUI KessΓ© Emmanuel](https://sikessem.com) via [[email protected]](mailto:[email protected]). All security vulnerabilities will be promptly addressed.

## πŸ“„ License

The SIKessEm Package is open-sourced software licensed under the [MIT License](https://opensource.org/licenses/MIT) - see the [LICENSE][l] file for details.

[l]: https://github.com/sikessem/iui-kit/blob/HEAD/LICENSE

------

IUI-Kit was created by [SIGUI KessΓ© Emmanuel](https://sikessem.com).