learningpool-ui v0.2.11

Learningpool UI (UUI)

Learningpool UI is the start of a library for use on Learningpool projects. There is a long-term vision, for now though, there are only a handful of components to utilize. It is built on top of MUI v4 but will make the jump to MUI v5 in the coming weeks.

This project was bootstrapped with Create React App.

Installation

First clone the repo then run:

yarn install

Available Scripts

In the project directory, you can run:

yarn start

Runs the app in the development mode.\ Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.\ You will also see any lint errors in the console.

Getting started

There is a TemplatePage component that can be found in the pages directory use this to get started when creating new components for the library. Follow the structure of the other components to start development.

Using the library

Add the following in the head of the project (if React it's likely to be index.html within the public directory).

<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:wght@400;600;700&display=swap" />
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Montserrat:wght@300;400;500&display=swap" />
<link rel="stylesheet" href="https://fonts.googleapis.com/icon?family=Material+Icons" />
<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.15.0/css/all.css" />

Importing and using components from the library.

import { VerticalNavigation } from 'learningpool-ui'

return <VerticalNavigation />

See all the components currently available components source code.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

There are related repositories which will be linked in the future.

License

MIT