Getting started

Amin Al Hazwani edited this page Jun 1, 2017 · 9 revisions

If you ended up here you probably want to update or contribute to the Firefox Design System website, very good! This wiki should give you all the necessary instructions in order to run this website locally or create, edit and publish new pages.

First things first! If you don't have this website running locally read the following instructions in order to do so.

If you already have the website locally running and you're a developer you may want to check the developing page. If you are a content creator you may want to check the writing page. If you are both, check both! As a last step check the contributing page.

Install Node.js

Open Terminal.app and check if Node is already installed on your machine:

$ node -v

If Node is not installed you can install it with Homebrew:

$ brew install node

Or, if you don't use Homebrew you can download it from nodejs.org.

Clone the repository

If you are part of the Firefox Design System team simply clone the repository. You can do it with Terminal.app or via the GitHub Desktop app. Once you have downloaded and installed the app go to the repository online on GitHub website and select first Clone and then Open in Desktop. For further help check their guide. If you prefer to clone it with Terminal.app run:

$ git clone git@github.com:firefoxux/photon.git

If you are an external contributor first fork the repository and then clone it from your GitHub account.

After you cloned the repository path to the its folder and install all node dependencies with Terminal.app:

$ cd path/to/repository
$ npm install

npm commands

To run (with hot-reloading!):

$ npm run serve

You can now got to http://localhost:3000 to see the website.

To build:

$ npm run build
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.