@brokeds/broke-everything NPM

About The Project

While there are plenty of css frameworks, design systems, and react component libraries out in the wild, it can be a struggle to find one that allows simple implementation and use along with heavy trust in the user to customize to their needs without having to jump through hoops. This project aims to remediate that.

Built With

Getting Started

Broken Design System is in it's very earliest stages at them moment so it's important to keep in mind that frequent updates will be the norm. Right now, what is available for use is very limited.

Installation

//TODO: This will be added when base features are implemented

Node Module

npm

npm i -D @brokeds/broke-everything

yarn

yarn add -D @brokeds/broke-everything

Then import the module inside of your entrypoint (eg. src/index.js)

import @brokeds/broke-everything

Github repo

Clone the repo and navigate to the full feature directory

git clone https:://github.com/SkothaSec/BrokeDS.git  && /
cd ./BrokeDS/BrokeEverything

Install NPM packages and start the server

npm i && yarn start

yarn add && yarn start

Usage

Using CSS in react app:

Import package in entry file

src/index.js

Package testing needs work first to test

placeholder For more examples, please refer to the Documentation

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.