AlaskaAirlines / AuroDocsSite

Repository for the management of the Auro doc site
https://auro.alaskaair.com/
0 stars 0 forks source link
auro design-system

Auro Design System Doc Site

Build Status

This repo is the home for auro.alaskaair.com.

This project adheres to all open-source best practices. Please review the Auro Contributing Guidelines for any information regarding the editing of the site.

Run site locally

After cloning the repo locally, please address these simple steps;

  1. $ npm i
  2. $ npm run dev

Environmental variable

To run the Github data service pages, you will need to add a /.env file, at the repo root, with a PAT (Personal Access Token) from Github. This file is intentionally ignored.

In your local /.env file add the following:

VITE_GH_TOKEN=[add your PAT]

To generate a PAT

Go to Personal access tokens, generate a new token with the following settings:

  1. repo:status
  2. repo_deployment
  3. public_repo
  4. read:discussion

Publish to site

The CI/CD pipeline will publish a new build of the site with each merge to master.