App-campus NPM

Campus

Repository for front end code related to Yello Campus Module.

Pre-development tasks

In order to run app-campus, you need access to Yello's npm orgs account because of this project's dependencies (single-page-app and front-end-styles).

Get npm orgs authToken from 1Password. If you do not have access to Yello Dev Engineering 1Password, contact security to request access.
echo "//registry.npmjs.org/:_authToken=$authToken" > ~/.npmrc - different shells (bash, zsh, etc) may handle the quotes differently. If you are still getting a 404 on npm install after adding this to your .npmrc, run cat ~/.npmrc and confirm that there are no quotes around that path.

Getting Started

Get Mockingbird

Mockingbird: Service to log in user for Single Page Application on local

Service that allows local development with ability to use endpoints on projo

Go to: https://code.yello.co/yello_enterprise_front_end/mockingbird
Follow README in that repo to get it up and running
After mockingbird is running, in this repo
- npm i
- npm run start
Open up http:microsoft.rc:8083 to run local development

Storybook

This repo uses Storybook (https://storybook.js.org/) for component demos, documentation, and a possible development environment. To get Storybook running:

cd app-campus
npm run storybook
navigate to http://localhost:6006/

Storybook allows you to:

See rendered components and interact with them (accessed via left sidebar)
See component-level documentation via the Notes tab
See basic accessiblity test results via the Accessiblity tab in the right sidebar
See the code for the current component via the Story tab in the right sidebar