Alexandria UI Library

:rocket: Preview https://eronbello.github.io/alexandria-library/

:information_source: About

Project to be used as a basis for new design systems projects

:computer: Technologies

• react
• storybook
• jest
• styled-components

Installation

Use the package manager NPM to install Alexandria Library.

npm install alexandria-library

:sassy_woman: Usage

Alexandria Library React packages are ready to use in a Create React App

Here is a simple example to get you started:

import React from 'react';
import ReactDOM from 'react-dom';
import { Button } from 'alexandria-library';

const App = () => (
  <>
    <Button>Example button</Button>
  </>
);

ReactDOM.render(<App />, document.getElementById('root'));

:information_source: Contribute

To clone and run this application, you'll need Git and NPM on your computer. From your command line:

# Clone this repository
$ git clone https://github.com/Eronbello/alexandria-library.git
# Go into the repository
$ cd alexandria-library
# install dependencies
$ npm install
# You can see the app running at: http://localhost:6006
$ npm run storybook

:information_source: Tests

To run the application tests, follow these steps:

$ npm run test

:rocket: Improvements

Possible improvements

• Add new components
• Add more examples
• Add more tests

License

MIT