This repository contains two simple Konva React projects.
npm install
npm update
npm start
```
Then, verify the project works by visiting [localhost:8080](http://localhost:8080)
Verify that the test suite still passes:
```
npm run test:full
```
If the updates are functional, please commit any changes to `package.json` or `package-lock.json` back to the
Starter Projects repository for future use.
If you want to build a local version run npm build
, it will create the files in the dist
folder.
You do not need to build to deploy the code, that is automatic. See more info in the Deployment section below.
This project is deployed using github actions. If the tests pass, npm build
is run and
code is deployed to an S3 website. For more details of the Github deployment process see
the file .github/workflows/ci.yml
and s3_deploy.sh
.
All branches are deployed to: https://fables-sims.concord.org/branch//
The production branch will be deployed to the root: https://fables-sims.concord.org/
The production version of the cart simulation is available at https://fables-sims.concord.org/branch/main/cart-index.html The production version of the boat simulation is available at https://fables-sims.concord.org/branch/main/tugboat-index.html
- Make sure if you are using Visual Studio Code that you use the workspace version of TypeScript.
To ensure that you are open a TypeScript file in VSC and then click on the version number next to
TypeScript React
in the status bar and select 'Use Workspace Version' in the popup menu.
Follow the instructions in this
Guide
to setup an S3 & Cloudfront distribution that can be used with Github actions.
See also s3_deploy.sh
, and ./github/ci.yml
.
Production releases to S3 are based on the contents of the /dist folder and are built automatically by GitHub Actions for each branch pushed to GitHub and each merge into production.
Merges into production are deployed to http://starter-projects.concord.org.
Other branches are deployed to http://starter-projects.concord.org/branch/.
To deploy a production release:
- Increment version number in package.json
- Create new entry in CHANGELOG.md
- Run
git log --pretty=oneline --reverse <last release tag>...HEAD | grep '#' | grep -v Merge
and add contents (after edits if needed to CHANGELOG.md) - Run
npm run build
- Copy asset size markdown table from previous release and change sizes to match new sizes in
dist
- Create
release-<version>
branch and commit changes, push to GitHub, create PR and merge - Checkout master and pull
- Checkout production
- Run
git merge master --no-ff
- Push production to GitHub
- Use https://github.com/concord-consortium/starter-projects/releases to create a new release tag
Run npm test
to run jest tests. Run npm run test:full
to run jest and Cypress tests.
Inside of your package.json
file:
--browser browser-name
: define browser for running tests--group group-name
: assign a group name for tests running--spec
: define the spec files to run--headed
: show cypress test runner GUI while running test (will exit by default when done)--no-exit
: keep cypress test runner GUI open when done running--record
: decide whether or not tests will have video recordings--key
: specify your secret record key--reporter
: specify a mocha reporter
cypress run --browser chrome
will run cypress in a chrome browsercypress run --headed --no-exit
will open cypress test runner when tests begin to run, and it will remain open when tests are finished running.cypress run --spec 'cypress/integration/examples/smoke-test.js'
will point to a smoke-test file rather than running all of the test files for a project.
Starter Projects are Copyright 2018 (c) by the Concord Consortium and is distributed under the MIT license.
See license.md for the complete license text.