Table of contents
Quick start
Several quick start options are available:
- Download the latest release..
- Clone the repo:
git@github.com:universelabs/meta.git
. - Install with npm:
npm install @universelabs/meta
. - Install with yarn:
yarn add @universelabs/meta
.
Status
![npm version](https://img.shields.io/npm/v/@universelabs/meta.svg?colorA=%23212121&colorB=%23007BFF)
What's included
Meta is currently a simple Sass file that gets compiled with Bootstrap Theming. More componentry and compatibility coming soon.
@universelabs/meta/
└── scss/
└── meta.scss
Documentation
The Meta documentation is a simple and easy to use Meta Design System
for you to reference and/or modify. There currently is no homepage to reference but will be coming soon. In the meantime, we recommend simply following the instructions below to get your version of the Meta Design System
up and running.
Running Meta Design System locally
- Quickly start by cloning the repository to your local machine
git clone git@github.com:universelabs/meta.git
. - Ensure you have
npm
installed. npm
comes bundled with Node.js. brew install node
. - Add dependencies
npm install
. - Start the local client side server and run the app. The app will automatically open your web browser and navigate to http://localhost:3000/ for you
npm start
.
For detailed instructions on how to customize Meta and the Meta Design System, visit Documentation.
Contributing
Please read through our contributing guidelines. Included are directions for opening issues, coding standards, and notes on development.
Moreover, if your pull request contains JavaScript patches or features, you
must include relevant unit tests. All code should conform to the Code Guidelines.
Get updates on Meta's development and chat with the project maintainers and community members.
For more details on how to get involved in the Universe Community visit the Universe Community page and learn more about events, roadmap, weekly & daily scrum, past weekly community scrum calls, and more...
Maintainers
Guy Lepage
License
By contributing your code, you agree to license your contribution under the
MIT License.
This project was bootstrapped with Create React App v2
and uses the UI framework Bootstrap as it's foundational base.