https://github.com/alaskaairlines/aurodocssite

Repository for the management of the Auro doc site
https://github.com/alaskaairlines/aurodocssite

auro design-system

Last synced: 15 days ago
JSON representation

Repository for the management of the Auro doc site

• Host: GitHub
• URL: https://github.com/alaskaairlines/aurodocssite
• Owner: AlaskaAirlines
• Created: 2020-12-09T23:06:34.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2024-12-18T00:40:10.000Z (about 2 months ago)
• Last Synced: 2024-12-18T01:33:53.113Z (about 2 months ago)
• Topics: auro, design-system
• Language: JavaScript
• Homepage: https://auro.alaskaair.com/
• Size: 13.9 MB
• Stars: 0
• Watchers: 6
• Forks: 0
• Open Issues: 35
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# Auro Design System Doc Site

[![Build Status](https://itsals.visualstudio.com/Auro%20Design%20System/_apis/build/status/auro-docsite/auro-docsite%20CI?branchName=master)](https://itsals.visualstudio.com/Auro%20Design%20System/_build/latest?definitionId=5591&branchName=master) 

This repo is the home for [auro.alaskaair.com](https://auro.alaskaair.com).

This project adheres to all open-source best practices. Please review the Auro [Contributing Guidelines](https://auro.alaskaair.com/getting-started/developers/contributing) 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`

1. `$ 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](https://github.com/settings/tokens), generate a new token with the following settings:

1. repo:status

1. repo_deployment

1. public_repo

1. read:discussion

## Publish to site

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