Skip to content

Commit

Permalink
Convert starter name to dst name.
Browse files Browse the repository at this point in the history
  • Loading branch information
tealefristoe committed Dec 18, 2024
1 parent 51b73fa commit 83c70b6
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 52 deletions.
6 changes: 3 additions & 3 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ jobs:
runs-on: ubuntu-latest
environment:
name: ${{ github.ref_type == 'branch' && 'branches' || 'versions' }}
url: https://codap3.concord.org/branch/main/?di=https://models-resources.concord.org/codap-plugin-starter-project/${{ steps.s3-deploy.outputs.deployPath }}/index.html
url: https://codap3.concord.org/branch/main/?di=https://models-resources.concord.org/dst-codap-plugin/${{ steps.s3-deploy.outputs.deployPath }}/index.html
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
Expand All @@ -41,10 +41,10 @@ jobs:
id: s3-deploy
with:
bucket: models-resources
prefix: codap-plugin-starter-project
prefix: dst-codap-plugin
awsAccessKeyId: ${{ secrets.AWS_ACCESS_KEY_ID }}
awsSecretAccessKey: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
# Parameters to GHActions have to be strings, so a regular yaml array cannot
# be used. Instead the `|` turns the following lines into a string
topBranches: |
["master"]
["main"]
45 changes: 0 additions & 45 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,51 +4,6 @@ This is a bare-bones React project, created with the `--typescript` version of [

## Development

### Copying a starter project

1. Create a new public repository for your project (e.g. `new-repository`)
2. Create a clone of the starter repo
```
git clone --single-branch https://github.com/concord-consortium/codap-plugin-starter-project.git new-repository
```
3. Update the starter repo
First, update and run the starter project:
```
cd new-repository
npm install
npm update
npm start
```
The browser should automatically open [localhost:8080](http://localhost:8080) (or 8081 if you are already using 8080). Checking for the words "CODAP Starter Plugin".
It's ok if you see an error like `handleResponse: CODAP request timed out: [{"action":"update","resource":"interactiveFrame","values":{"name":"Sample Plugin","version":"0.0.1","dimensions":{"width":380,"height":680}}},{"action":"get","resource":"interactiveFrame"}]`. This just means that the plugin is running outside of Codap, so is not receiving responses to API requests, which is expected.
Also verify that the test suite still passes:
```
npm run test
```
4. Next, re-initialize the repo to create a new history
```
rm -rf .git
git init
```
5. Create an initial commit for your new project
```
git add .
git commit -m "Initial commit"
```
6. Push to your new repository
```
git remote add origin https://github.com/concord-consortium/new-repository.git
git push -u origin master
```
7. Open your new repository and update all instances of `codap-plugin-starter-project` to `new-repository`.
Note: this will do some of the configuration for Travis deployment to S3, but you'll still need to follow
the instructions [here](https://docs.google.com/document/d/e/2PACX-1vTpYjbGmUMxk_FswUmapK_RzVyEtm1WdnFcNByp9mqwHnp0nR_EzRUOiubuUCsGwzQgOnut_UiabYOM/pub).
8. Your new repository is ready! Remove this section of the `README`, and follow the steps below to use it.
### Initial steps

1. Clone this repo and `cd` into it
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "codap-plugin-starter-project",
"name": "dst-codap-plugin",
"version": "0.0.1",
"description": "Concord Consortium Starter CODAP Plugin",
"description": "Data in Space Time CODAP Plugin",
"main": "index.js",
"browserslist": "> 0.2%, last 5 versions, Firefox ESR, not dead, not ie > 0",
"jest": {
Expand Down

0 comments on commit 83c70b6

Please sign in to comment.