https://github.com/justeat/global-component-library

Global Component Library and Documentation for sharing across UK and International
https://github.com/justeat/global-component-library

fozzie ui

Last synced: about 2 months ago
JSON representation

Global Component Library and Documentation for sharing across UK and International

• Host: GitHub
• URL: https://github.com/justeat/global-component-library
• Owner: justeat
• License: other
• Created: 2017-05-10T15:05:54.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2023-05-17T03:50:41.000Z (over 1 year ago)
• Last Synced: 2024-10-31T19:51:38.425Z (2 months ago)
• Topics: fozzie, ui
• Language: CSS
• Homepage: https://fozzie.just-eat.com/
• Size: 10.7 MB
• Stars: 2
• Watchers: 38
• Forks: 3
• Open Issues: 24
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        


Global Component Library




The Global Component Library stores the files used to generate the Fozzie documentation website.



---

[![Build Status](https://travis-ci.org/justeat/global-component-library.svg)](https://travis-ci.org/justeat/global-component-library)

## Usage

To get up and running with the Fozzie Component Library, follow these steps:

1. Clone this repo to your local machine `git clone https://github.com/justeat/global-component-library.git`

2. In your command prompt, run `yarn` from the base of the project. This will install all of the necessary project dependencies.

3. Once installed, run `gulp docs` in your command prompt.  This will compile and run a local version of the site. This should look like the component library hosted at https://fozzie.just-eat.com/

## Deploying a new version

If you've added new documentation to the component library, it's important that it's deployed to the public site at https://fozzie.just-eat.com/.

To do this, run `gulp docs:deploy` from the root of the project in your command prompt.  This runs a gulp task that will compile and deploy the site to Github pages.