Web ui kit

Utilities to support progressive web apps development

Table of Contents

• Getting started
  • Development environment
• Project specifications
  • Features
  • Folder structure
• Maintenance
• License

Getting started

First of all, install package as a dependence of your project

$ npm install --save @supernovaxxx/web-ui-kit

Development environment

Make sure you have Git, Node and NPM installed:

$ git --version
git version 2.25.1
$ node --version
v18.12.1
$ npm --version
9.2.0

Thus, clone the recent-created repository locally, and you'll be ready to start developing your project.

Project specifications

Here some descriptions about this package:

Features

This includes the following utilities to streamline web ui development: ...to be described

Folder structure

.
├── .git/                       Version control system folder
├── .gitignore                  VCS ignored files manifest
├── CHANGELOG.md                Release notes description
├── LICENSE                     License file
├── package.json                Node package descriptor
└── README.md                   Repo readme document

Maintenance

This project is maintained by the author, @artu-hnrq.
Though, minimal or no implementation has been done yet, it's only intended to be a limited example, demo, or proof-of-concept.

License

This project is published under the permissions established by GNU General Public License v3.0.