Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/neoground/neopren

The Neopren Design System
https://github.com/neoground/neopren

bootstrap design-system preact

Last synced: 8 days ago
JSON representation

The Neopren Design System

Awesome Lists containing this project

README 

        
# Neopren Design System



![Header Banner](https://neoground.com/data/docs/neopren/assets/hero.webp)



---



Welcome to the Neopren Design System — a cutting-edge toolkit crafted to revolutionize the way you build web

applications. Tailored for the modern developer, Neopren combines artistic aesthetics with functional design, allowing

you to rapidly create professional, highly engaging web applications with ease.



## Features



- **Modern Design Aesthetic**: Embrace a sleek, user-friendly interface that captures attention and delivers an

  exceptional user experience.

- **Comprehensive Component Library**: Dive into a rich collection of pre-designed components that are versatile and

  easy to integrate.

- **Optimized for Performance**: Enjoy a design system that is fine-tuned for speed and efficiency, making your projects

  run smoother and faster.



## Built With



Neopren is meticulously crafted using the latest technologies and tools to provide you with a robust and adaptable

environment for web development:



- **Bootstrap 5.3**: Leverage the latest version of the world’s most popular front-end open-source toolkit to build

  responsive, mobile-first projects on the web with the most powerful and in-depth grid system and extensive prebuilt

  components.

- **Yarn**: Depend on fast, reliable, and secure dependency management to keep your projects streamlined and up to date.

- **Preact + Hyperscript Tagged Markup (HTM)**: Utilize the 3kB alternative to React with the same modern API, coupled

  with HTM for a JSX-like syntax that works at runtime without the need for a transpiler.



## Optimized for Charm PHP Framework



The Neopren Design System is fully integrated and optimized for use with the Charm PHP Framework, enhancing its

capabilities with:



- **Seamless Integration**: Ensure that every component and utility in the Neopren system works seamlessly within the

  Charm ecosystem, providing a consistent and intuitive development experience.

- **Extended Functionality**: Benefit from custom extensions and plugins designed specifically for Charm, enhancing

  functionality without compromising on performance.

- **Scalability and Maintainability**: Build applications that are not only fast and responsive but also easy to scale

  and maintain over time.



## Getting Started



To get started with Neopren, follow these simple steps:



1. **Install via Yarn (recommended)**:

   ```bash

   yarn add neoground/neopren

   ```



2. **Or via NPM**:

   ```bash

   npm install neoground/neopren

   ```



3. **Integrate with Charm PHP**:

   Follow the detailed documentation to integrate Neopren with your Charm PHP projects efficiently. It is available

   as a composer module:

   ```bash

   composer require neoground/neopren

   ```



## Documentation



For comprehensive guides, component details, and API references, please visit

our [documentation](https://neoground.com/docs/neopren/index). Here, you will find all the resources needed to utilize

Neopren to its fullest potential.



## Currently in Alpha



Please note that we're currently actively developing neopren. We already use it in our own apps but it's still far from

being a stable design system. Over the course of this year we'll add all needed modules so you can use it for your own

apps as well.



## Contribute



Neopren thrives on community contributions. Whether it's improving documentation, reporting bugs, or proposing new

features, your input is highly valued.



## License



This project is licensed under the Mozilla Public License 2.0 (MPL 2.0) -

see the [LICENSE.md](LICENSE.md) file for details.

If a copy of the MPL was not distributed with this file, You can obtain one at

[https://mozilla.org/MPL/2.0](https://mozilla.org/MPL/2.0).



Copyright (c) 2024 Neoground GmbH