alenite-design v0.1.8

Alenite Design

Alenite Design is a React UI library designed to provide a set of reusable components for building modern web applications. It's mainly inspired by Material Design 3

Table of Contents

• Installation
• Usage
• Components
• Contributing
• License

Installation

To install Alenite Design, you can use npm. Haven't published the repository on npmjs yet so:

npm install alenite-design

Usage

To use a component from Alenite Design, simply import it into your React application:

import React from 'react';
import { Button } from 'alenite-design';

const App = () => (
  <div>
    <Button>Click Me</Button>
  </div>
);

export default App;

Also remember to import the styles:

require('alenite-design/lib/index.css')

Components

Alenite Design provides the following components:

• Button: A basic button component.
• Input: A customizable input field.
• Modal: A modal dialog component.
• Card: A card component for displaying content.

Contributing

We welcome contributions to Alenite Design! If you have any ideas, suggestions, or bug reports, please open an issue or submit a pull request.

Building

To set up the development environment:

1. Clone the repository:

git clone https://github.com/onyxcodes/alenite-design.git

2. Install dependencies:

npm install

3. Run build

npm run build

And you should be good go.

Running tests

To run the tests, use the following command:

License

Alenite Design is licensed under the CC-BY-SA-4.0 License. See the LICENSE file for more information.

Author

Onyx - onyx.ac