From 5406deb049907ea04258f06738b551881d99ef83 Mon Sep 17 00:00:00 2001 From: Pat Udomprasert Date: Tue, 16 Apr 2024 17:55:04 -0400 Subject: [PATCH 1/4] Update README.md --- README.md | 37 +++++++++---------------------------- 1 file changed, 9 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index 101ac5a..1121dc1 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,13 @@ -# Vue Data Story Template +# TEMPO LITE -This repository contains a template for setting up a purely Vue-based Cosmic Data Story using WorldWide Telescope. This template is built using components from [`@cosmicds/vue-toolkit`](https://github.com/cosmicds/vue-toolkit), which is included here as a dependency. This template sets up the basic infrastructure for a story - integrating the WorldWide Telescope component, providing some basic HTML scaffolding for placing controls in the main component, and generally providing the overall Vue project structure. +This repository is for the "lite" js-only TEMPO data map viewer. -## Usage +It is based on code developed by @jfoster17 in [Jonathan's repo](https://github.com/jfoster17/jfoster17.github.io/commit/46cc5b425d7e8833ab7fa659dc165764595d3c73) and the commits that follow. -To start creating your own data story, you can use the following steps. +## Developer quick start -* First, clone the repository, setting the name of the destination folder as appropriate for your story -``` -git clone https://github.com/cosmicds/vue-ds-template.git -``` -* Next, you can run the setup script to do some basic renaming for you. You should give the story name in `kebab-case`. Where conventions dictate, the script will automatically rename using `PascalCase` and `camelCase`. -``` -cd -scripts/setup.sh -``` -If you get complaints that the script isn't executable, make it so by running `chmod +x scripts/setup.sh`. - -* That's it! You're now ready to start creating your story. As mentioned above, we provide some basic layout scaffolding in the main component template, but feel free to remove whatever doesn't fit your story's needs. - - To preview the story using the development server, run `yarn serve` - - To build the story for production use, run `yarn build` - -## Deployment and Github Actions - -The built story is just a set of HTML/CSS/JS + any assets that you add, so it should be easy to host anywhere. One simple way to host a story is using Github Pages, which provides a free static site hosting service for public repositories. This repository provides two workflows (see the `.github/workflows` directory) to help with this: -* `build.yml` - on a pull request, build the PR version of the story (to test that it at least builds successfully) -* `build-deploy.yml` - on a commit to main, build the story and push the built version to the `gh-pages` branch. This built version can then be deployed to Github Pages in the repository settings: `Settings > Pages`, then choose `Deploy from a branch` and use the `gh-pages` branch. - -## BrowserStack testing - CosmicDS team - -If you're a member of the CosmicDS team, we can perform E2E testing (both locally and in Github Actions) using BrowserStack. To activate this testing, uncomment the relevant pieces in the provided workflows. Note that you'll need to have our BrowserStack username and access key for this to work correctly. (If the repository that you're working on is part of the CosmicDS organization, you shouldn't need to add these at the repository level). +1. Check out the repository to your machine +2. If necessary, install [Node.js](https://nodejs.org/en/) and [Yarn](https://yarnpkg.com/) +3. `cd ` +4. `yarn` (to install dependencies) +5. `yarn serve` (to run development server for TEMPO Lite Data Story) From 885f45bd97598b7b5a16c6a09e1c6ae5a4889b77 Mon Sep 17 00:00:00 2001 From: Pat Udomprasert Date: Tue, 16 Apr 2024 17:58:28 -0400 Subject: [PATCH 2/4] link edit and extra step --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1121dc1..5bad8ab 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ This repository is for the "lite" js-only TEMPO data map viewer. -It is based on code developed by @jfoster17 in [Jonathan's repo](https://github.com/jfoster17/jfoster17.github.io/commit/46cc5b425d7e8833ab7fa659dc165764595d3c73) and the commits that follow. +It is based on code developed by @jfoster17 in [this repo](https://github.com/jfoster17/jfoster17.github.io/commit/46cc5b425d7e8833ab7fa659dc165764595d3c73) and the commits that follow. ## Developer quick start @@ -11,3 +11,4 @@ It is based on code developed by @jfoster17 in [Jonathan's repo](https://github. 3. `cd ` 4. `yarn` (to install dependencies) 5. `yarn serve` (to run development server for TEMPO Lite Data Story) +6. Copy/paste url (under "App running at:") into your browser \ No newline at end of file From 3843e35a6499b4c17bf577ff6a2de4ee0027b0c7 Mon Sep 17 00:00:00 2001 From: Pat Udomprasert Date: Tue, 16 Apr 2024 17:59:57 -0400 Subject: [PATCH 3/4] More baby edits --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 5bad8ab..449df74 100644 --- a/README.md +++ b/README.md @@ -6,9 +6,9 @@ It is based on code developed by @jfoster17 in [this repo](https://github.com/jf ## Developer quick start -1. Check out the repository to your machine -2. If necessary, install [Node.js](https://nodejs.org/en/) and [Yarn](https://yarnpkg.com/) +1. Check out the repository to your machine. +2. If necessary, install [Node.js](https://nodejs.org/en/) and [Yarn](https://yarnpkg.com/). 3. `cd ` 4. `yarn` (to install dependencies) 5. `yarn serve` (to run development server for TEMPO Lite Data Story) -6. Copy/paste url (under "App running at:") into your browser \ No newline at end of file +6. Copy/paste url (under `App running at:`) into your browser \ No newline at end of file From b0abb3443595dac35023dbc2b5dd7a6429e8037d Mon Sep 17 00:00:00 2001 From: Pat Udomprasert Date: Tue, 16 Apr 2024 18:01:13 -0400 Subject: [PATCH 4/4] punctuate --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 449df74..6ca5724 100644 --- a/README.md +++ b/README.md @@ -11,4 +11,4 @@ It is based on code developed by @jfoster17 in [this repo](https://github.com/jf 3. `cd ` 4. `yarn` (to install dependencies) 5. `yarn serve` (to run development server for TEMPO Lite Data Story) -6. Copy/paste url (under `App running at:`) into your browser \ No newline at end of file +6. Copy/paste url (under `App running at:`) into your browser. \ No newline at end of file