From 34b084fef0976eb43cb5a85f28bc158f9ab67c3b Mon Sep 17 00:00:00 2001 From: Garth Braithwaite Date: Thu, 18 Jan 2024 10:59:42 -0700 Subject: [PATCH] Update visualizer README.md, closes #242 --- docs/visualizer/README.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/visualizer/README.md b/docs/visualizer/README.md index 1547ce0a..62475324 100644 --- a/docs/visualizer/README.md +++ b/docs/visualizer/README.md @@ -1,36 +1,36 @@ # Spectrum Token Visualization Tool -Current url of deployed static site: [https://git.corp.adobe.com/pages/Prototype/spectrum-token-visualization-tool/](https://git.corp.adobe.com/pages/Prototype/spectrum-token-visualization-tool/) +Current url of deployed static site: [https://opensource.adobe.com/spectrum-tokens/visualizer/](https://opensource.adobe.com/spectrum-tokens/visualizer/) -Screenshot 2023-02-28 at 2 40 02 PM +Screenshot 2023-02-28 at 2 40 02 PM ## Setup for local development First, checkout the source code ``` -git clone git@git.corp.adobe.com:Prototype/spectrum-token-visualization-tool.git +git clone git@github.com:adobe/spectrum-tokens.git ``` -Navigate into the /spectrum-token-visualization-tool directory +Navigate into the spectrum-token-visualization-tool directory. ``` -cd stvt +cd spectrum-tokens/docs/visualizer/ ``` Install package dependencies ``` -npm install +pnpm install ``` Startup the local development webserver ``` -npm run dev +pnpm moon run visualizer:dev ``` -Now you can edit any project files and your browser will hot-reload with your changes. +Now you can edit any project files, and your browser will hot-reload with your changes. This project is based on the Vite Lit Element Typescript boilerplate static site tooling. @@ -39,7 +39,7 @@ You can read all about Vite here: https://vitejs.dev/guide/ You can read all about Lit Element here: https://lit.dev/docs/api/LitElement/ _LOCAL DEVELOPMENT NOTE_ -Because we use web workers to offload some of the data processing, local development must be done in a browser that supports Worker Ecmascript Modules: https://caniuse.com/mdn-api_worker_worker_ecmascript_modules. In other words: You can use Chrome or Safari, but NOT Firefox ( as of 12.15.2022 ). This note applies ONLY to the local development webserver. Firefox does work correctly with the built static site. +Because we use web workers to offload some of the data processing, local development must be done in a browser that supports Worker Ecmascript Modules: https://caniuse.com/mdn-api_worker_worker_ecmascript_modules. In other words, you can use Chrome or Safari, but NOT Firefox ( as of 12.15.2022 ). This note applies ONLY to the local development webserver. Firefox does work correctly with the built static site. ## Updating the deployed static site @@ -48,7 +48,7 @@ The static site is hosted from the `/docs` directory of the `main` branch. Build the static site locally. This will overwrite the contents of the /docs directory in the project. ``` -npm run build +pnpm moon run visualizer:build ``` Commit the updated static site files to the git repo. @@ -63,7 +63,7 @@ git push ## What is this prototype? How does it work? -The Spectrum Tokens source-of-truth is persisted in this public github repo: https://github.com/adobe/spectrum-tokens +The Spectrum Tokens source-of-truth is persisted in this public GitHub repo: https://github.com/adobe/spectrum-tokens Within that repository, the tokens are stored in a series of JSON files: https://github.com/adobe/spectrum-tokens/tree/beta/src