Skip to content

SGNUIKit is a very powerful UI kit designed to allow web developers use the power of the kit to build efficient and beautiful websites. SGNUIKit is currently being used in all the websites by SGNetworks.

License

Notifications You must be signed in to change notification settings

SGNetworksIndia/SGNUIKit

Repository files navigation

The SGNUIKit

SGNUIKit is a very powerful UI kit designed to allow web developers use the power of the kit to build efficient and beautiful websites. SGNUIKit is currently being used in all the websites by SGNetworks. SGNUIKit is released under its exclusive license SGN CS License v1.1.

REQUIREMENTS

Current SGNUIKit Version: 1.2.1

Core Requirements

Technology Version Link
jQuery 3.6.3 https://jquery.com/download/

Note: If the dependencies omitted, it will neither break the features nor impact the performance of SGNUIKit as it comes built-in with SGNUIKit and the built-in dependencies will be used.

Web Standards Compatibility (Web 2.0)

Technology Version (Minimum) Version (Maximum) Notes
CSS 2.0 3.0 Some layouts might break in minimum version
JavaScript ES4 ES6 Some functions might break in minimum version

INSTALLATION

Download the latest version of SGNUIKit from: sgnuikit.lib.sgnetworks.eu.org/downloads or github.com/SGNetworksIndia/SGNUIKit/releases, and extract the archive on the on any directory you want (preferably, /assets/vendor/).

Now add the following line of code <script src="/assets/vendor/SGNUIKit/js/SGNUIKit.loader.js"></script> between the <head></head> tags. And the rest will be taken care of by the loader.

Now you are ready to start developing your website using SGNUIKit. For more information, read the documentation.

We suggest you to set up AppCache and a Service Worker to enable caching. Doing so will make the web pages to load faster and your website will be able to load even in offline and there are many other good reasons to set up AppCache and a Service Worker, one of them is it enables you to use Push Notification service. We recommend you to do this as the main script is larger than 1MB (approximately, 3.6MB).

DOCUMENTATION

The documentation for SGNUIKit is available at sgnuikit.lib.sgnetworks.eu.org/docs and a tutorial on setting up a Progressive Web App (PWA) using JavaScript which be found at freecodecamp.org/news.

KNOWN BUGS

No known bugs till the release.

UPCOMING FEATURES

There are many features are staged to be implemented in the upcoming releases. The currently planned features awaiting to be implemented are:

    • BottomSheets (like Android Material Design)
    • Windows (like desktop windows)
    • File (Image) upload preview (crop)
    • Drag & Drop Panels/Cards
    • Themes
  1. And many more...

CONTRIBUTING

To contribute on the SGNUIKit Core, send an email on contribute@sgnuikit.lib.sgnetworks.eu.org with the following information:

  • Your real name
  • Your GitHub Username
  • Your contact E-mail ID (where you can be reached)
  • Describing your skills and an idea on how the upcoming features can be implemented

If you are selected, you'll receive an email from the core development team with all the information required to move forward.

Or if you have a new feature which can be added in the SGNUIKit Core, just email to rfc@sgnuikit.lib.sgnetworks.eu.org with your proposal.

Or if you found a bug or error which need to be fixed create an issue at issues or if you think you can fix the issue, report the bug to bug@sgnuikit.lib.sgnetworks.eu.org explaining the issue you found.

CREDITS

SGNUIKit is being developed by Team SGNUIKit in association with SGNetworks and Indiosco Technologies Private Limited.

About

SGNUIKit is a very powerful UI kit designed to allow web developers use the power of the kit to build efficient and beautiful websites. SGNUIKit is currently being used in all the websites by SGNetworks.

Topics

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Packages

No packages published