/lib is the build directory transpiled from /src.

Sandbox

The Sandbox is a free standing Create React App used as a development environment for Core UI Features @neustar/core-ui.

Additionally it stands as a How To for many aspects & features of the system.

Getting started

./src

From the root / run yarn install. To build: yarn build.

./sandbox

CD into sandbox, then yarn install.

To edit: yarn start
- Loads dev sandbox available at http://sandbox.security.neustar:4000/.
- Build @neustar/core-ui before running Sandbox.
- Add sandbox.security.neustar to your hosts file associate with the loopback route 127.0.0.1.
```
  127.0.0.1 sandbox.security.neustar
```
- Edits to hosts file must be done with VPN disconnected, as the Pulse Secure overwrites the file.

Implementation

To prepare an application for implementation:

Back End

Review Site's back end services for Auth/User transactions (activation, password reset, login, logout, userinfo etc.). These will require RESTful corollaries applied, if not deprecation.

Front End

Reduce Application structure down to just the content section containing routes. No header, footer or navigation.
Port routing system to Reach Router @reach/router
Removing all styling (css, sass etc.) from Application is strongly recommended.

Core Boot Loader

CoreBootLoader is how developers apply the Core UI to their free-standing react app. See http://localhost:4000/home/how-to-use

Example here.

CoreBootLoader requires 1 Plugin: AuthPlugin, which applies clientID, domain & audience parameters to host an auth0-lock implementation in the Application.

Example here.

Spikes are code explorations that are quarantined away from develop to prevent ref pollution. Each spike can be tagged for external testing via semantic versioning...which will produce a version tag like x.x.x-spike.x

Run a Spike.

Developer must start with fresh refs from develop:

From develop run:
- If spike exists locally:
```
  git branch -D spike
```
- ```
  git checkout spike
```
- ```
  git push -f spike
```
  Now we have a shared spike branch that matches refs from develop. Please make sure no other developer is currently running a spike.

From spike run:

  git checkout -b <:DEVELOPER INITIALS>-spike-<:SPIKE NAME>

Deploy a Spike.

To create a tagged spike branch for external testing:

From <:SPIKE NAME>:
- Push to repo.
- In GitLab:
  - Start a Merge Request with spike as your target branch.
  - Merge Request Title must start with a semantic versioning prefix: fix: <:COMMIT MESSAGE>.
  - Once merged a tag will be created for it.

Complete a Spike.

When you are satisfied with your new code, we need to merge your changes back into develop without the burden of the spike's internal refs.

From your spike branch run:

  git reset --soft $(git merge-base develop <:SPIKE_BRANCH>) && git commit -am "<:COMMIT MESSAGE>" && git rebase -i develop

Follow the deploying directions above, but target develop branch.
Make sure only a single commit is being submitted.

core-ui

Vercara Core UI

Overview

@neustar/core-ui