Skip to content

Latest commit

 

History

History
124 lines (84 loc) · 4.83 KB

README.md

File metadata and controls

124 lines (84 loc) · 4.83 KB

image

NuKleus Design System

NuKleus Design System is a comprehensive set of guidelines, components, and resources that serve as the foundation for creating consistent, accessible, and user-friendly digital experiences across all products and platforms of the Independent Society of Knowledge (ISK). It is a central repository that unifies our design language, user interface elements, interaction patterns, and best practices, enabling efficient collaboration and streamlined development processes.

Table of Contents

Introduction

The primary purpose of NuKleus Design System is to establish a cohesive and seamless user experience across our diverse range of scientific research and product offerings. By adhering to a standardized design system, we aim to:

  • Enhance brand recognition and reinforce our organization's identity through consistent visual language and interactions.
  • Improve usability and accessibility, ensuring that our products are intuitive and inclusive for users with varying abilities and preferences.
  • Foster efficiency and collaboration among design and development teams by providing a shared set of reusable components and guidelines.
  • Promote scalability and flexibility, enabling rapid adaptation to emerging technologies, platforms, and user needs.
  • Uphold the Independent Society of Knowledge's values of scientific rigor, knowledge dissemination, and technological advancement through evidence-based design decisions and user-centric approaches.

NuKleus Design System is built upon the foundation of IBM's industry-leading Carbon Design System, inheriting its core principles and best practices. However, we have tailored and extended these guidelines to align with the specific needs and values of the Independent Society of Knowledge.

Key Features

  • Consistent Design Language: Unified guidelines and visual styles for all ISK products.
  • Accessibility: Components and patterns designed to be inclusive for all users.
  • Reusable Components: A shared library of components for efficient development.
  • Scalability: Flexible system adaptable to various platforms and emerging technologies.
  • Collaboration: Streamlined processes for design and development teams.

Getting Started

To get started with NuKleus Design System, follow these steps:

  1. Clone the Repository:

    git clone https://github.com/ISK-Portal/NuKleus.git

  2. Install Dependencies:

    cd NuKleus
npm install

  3. Run the Development Server:

    npm start

  4. Explore the Documentation: Visit NuKleus Documentation for detailed guidelines and usage instructions.

Modules

NuKleus Design System repository contains multiple modules to cater to different frameworks and platforms:

Vue Module

The Vue module provides a comprehensive set of Vue components adhering to NuKleus guidelines.

  • Installation:

    npm install @nukleus/vue

  • Usage:

    import { Button } from '@nukleus/vue';

React Module

The React module offers a complete library of React components designed according to NuKleus principles.

  • Installation:

    npm install @nukleus/react

  • Usage:

    import { Button } from '@nukleus/react';

Other Modules

Additional modules for other frameworks and platforms will be provided to ensure comprehensive support and integration.

Contributing

We welcome contributions to NuKleus Design System! To get started:

  • Read our Contribution Guidelines: Contribution Guidelines
  • Submit Issues and Pull Requests: Contributions should be submitted through GitHub.
  • Contact Us: For major changes or ideas, email us at [email protected].

Support

For support and inquiries, please contact us at [email protected].

License

NuKleus Design System is licensed under the GPLv2.0 License. See the LICENSE file for more details.

Acknowledgements

NuKleus Design System is built upon IBM's Carbon Design System. We extend our gratitude to the Carbon Design System team for their extensive research and development efforts.

ISK Website: iskportal.com

NuKleus Documentation: NuKleus Documentation