https://github.com/pod-point/dom-components
https://github.com/pod-point/dom-components
frontend-development software-team
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/pod-point/dom-components
- Owner: Pod-Point
- Created: 2020-09-24T14:20:26.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-01-09T04:05:37.000Z (over 2 years ago)
- Last Synced: 2025-04-13T08:56:58.595Z (about 1 year ago)
- Topics: frontend-development, software-team
- Language: JavaScript
- Homepage:
- Size: 2.7 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# DOM Components
NOTE: This is a work in progress.
If there are any components that are required in the meantime, please create an issue in github [here](https://github.com/Pod-Point/dom-components/issues).
The purpose of this design system is to show how elements/components should be displayed across our many products, and the tools and processes we use to achieve this.
## Installation
```bash
npm install --save @pod-point/dom-components
```
## Development
First, install all of the Node modules needed:
```bash
git clone git@github.com:Pod-Point/dom-components.git
cd dom-components
npm install
```
## Tasks
```bash
npm start
```
```bash
npm build
```
## Documentation
See full docs [here](https://pod-point.github.io/dom-components)
## TailwindCSS
To use Tailwind and the Pod Point config, first [install Tailwind](https://tailwindcss.com/docs/installation) to your project and then copy the `tailwind.config.js` file into the root of your project and build the assets, we tend to use Gulp, but feel free to build as you wish.
## Fabricator
This design system has been built using [Fabricator](https://fbrctr.github.io/)
Fabricator is a tool for building website UI toolkits - _think ["Tiny Bootstraps, for Every Client"](http://daverupert.com/2013/04/responsive-deliverables/#tiny-bootstraps-for-every-client)_
### Fabricator Documentation
#### [Read the docs →](http://fbrctr.github.io/docs)