Skip to content

Latest commit

 

History

History
79 lines (51 loc) · 1.93 KB

README.md

File metadata and controls

79 lines (51 loc) · 1.93 KB
Raw

IsomerCMS Frontend

This repo contains the source code for the IsomerCMS frontend.

How it works

The frontend is built using React and hosted on Netlify. The frontend interacts with the IsomerCMS backend server, which in turn calls GitHub APIs to modify code in the users' Isomer website repo.

How to develop

source .env
npm install
npm run start

Setting up GitGuardian

To setup, follow these instructions:

  1. Install GitGuardian
brew install gitguardian/tap/ggshield
  1. Add the API Key to your .env file
# Service API key from GitGuardian account
export GITGUARDIAN_API_KEY=abc123

Notes:

Only if necessary,

  • To skip all pre-commit hooks, use $ git commit -m "commit message" -n
  • To skip only GitGuardian’s hook, use $ SKIP=ggshield git commit -m "commit message"

Running end-to-end tests using Cypress

Add the following Cypress environment variables:

  • CYPRESS_BASEURL (CMS frontend baseurl of the environment you want to test)
  • CYPRESS_COOKIE_NAME (The name of the specialized cookie used for E2E testing)
  • CYPRESS_COOKIE_VALUE (The value of the above cookie)
  • CYPRESS_TEST_REPO_NAME (Name of the test repo on GitHub)

Add the following environment variables which we use to reset our test repo:

  • E2E_COMMIT_HASH (the commit hash which you would like to reset the e2e-test-repo to)
  • PERSONAL_ACCESS_TOKEN (your GitHub personal access token)
  • USERNAME (your GitHub username)

Run the following:

source .env
npm run test-e2e

If you would like the Cypress UI, run

npm run cypress:open

For more information on setup, read the cypress/SETUP.md

Release

Run the following on the release branch to tag and push changes automatically:

npm run release --isomer_update=<versionType>

where versionType corresponds to npm version types. This only works on non-Windows platforms, for Windows, modify the release script to use %npm_config_update% instead of $npm_config_update.