neptune-ui v0.4.0

🌊🔱 neptune-ui

awesome react component library, built with styled-components

the goal of this project is to create a portable set of primitive components for rapidly prototyping react projects, with an easily customisable system of sensible design defaults built right in.

🔮 prerequisities

this project is written in javascript. get node to work on this project.

if you want to create apps with neptune, you'll also need to have node/npm installed.

🏃‍♀️ up and running

1. fork and clone this repository
2. install node/npm
3. cd neptune-ui
4. yarn && yarn dev

⚙️ how to use

🚧 neptune is very much WIP, so hold up on using it in production for now!

1. start a React project.
2. yarn add neptune-ui

3. use the <Provider /> component at the root of your application:

   <Provider>
   ...
   </Provider>

4. you may also want to inject some styles into your application:

   import { injectGlobal } from 'styled-components'
   
   injectGlobal`
     * { box-sizing: border-box; }
     body { margin: 0; }
   `

5. ✨ start building!