Wayfinder

This project was bootstrapped with Create React App.

Quick Start

Download all the dependencies using NPM:

npm ci

Run the app in the development mode:

npm start

This will open http://localhost:3000 to view it in your browser.

The page will reload when you make changes. You may also see any lint errors in the console.

When you're finished, you can build a production release by updating the VERSION.txt file and running:

make build

This bundles React in production mode and compresses all the files into a versioned tarball inside of the artifact directory. Your app is now ready to be deployed!

Deployment Information

The VERSIONS.txt file found in the root directory of this repo follows the Semantic Versioning system and should be updated accordingly whenever a new release is to be prepared.

Once the bundled artifact has been produced via

make build

it should be included as a binary attachment in a new GHE release corresponding to the appropriate commit complete with a version number tag matching that which is found in the VERSION.txt file.

The versioned release should then downloaded, decompressed, and put into the source directory within the IaC for wayfinder (currently infrastructure-modules/wayfinder/src).

At this point, applying the IaC changes will deploy the webapp.

Other Available Commands

In the project directory, you can run:

make clean

Removes all versioned tarballs from the artifact directory.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

npm run eject

Note: this is a one-way operation. Once you eject, you can't go back!

If you aren't satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.

You don't have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

InCommon/wayfinder

About

Resources

Uh oh!

Stars

Watchers

Forks

Releases 5

Packages 0

Uh oh!

Contributors 4

Uh oh!

Languages

Packages