diff --git a/README.md b/README.md index 6a70161..8bd88d3 100644 --- a/README.md +++ b/README.md @@ -37,9 +37,44 @@ To build this site: - Run `npm run dev` - The site will be available in real time via a localhost URL +### Generate a self-signed certificate + +In order to run this repo in local development mode, two files must be added to the repo's root directory. The following set of commands apply to a macOS system. However, if mkcert is installed by another package manager, this can be run on any flavor of *nix. + +```bash +cd ~/.ssh +brew install mkcert # replace with another package manager for linux distro +brew install nss # need to install certutil before running `mkcert -install` so the CA can be automatically installed in Firefox + +# at this point, open any https website in Firefox before running the below commands + +mkcert -install +mkcert -key-file localhost_key.pem -cert-file localhost_cert.pem localhost 127.0.0.1 +cat localhost_cert.pem > localhost_fullchain.pem +cat "$(mkcert -CAROOT)/rootCA.pem" >> localhost_fullchain.pem +``` + +Now, navigate to your project directory, wherever the repo was cloned to, for example cd `~/Sites/work/website` and copy the `.pem` files into the repo root. These keys are .gitignored by default. + +Or run the below command to copy the files to your currently `cd`’d dir automatically + +```bash +cp -v ~/.ssh/localhost_cert.pem ~/.ssh/localhost_key.pem . +``` + +### Environment variables + +Add the following `.env` file to the repo root + +```ini +NODE_ENV=development +SERVER_ENV=development +AIRTABLE_SINGULARITY_ACCESS_TOKEN= +``` + ## Updating dependencies -Please use `npm ci` in place of `npm i` when not explicitly upgrading dependencies. `npm ci` will only install versions of packages provided in the lockfile, leading to more stability. +Please use `npm ci` in place of `npm i` when not explicitly upgrading dependencies. `npm ci` will only install versions of packages provided in the lockfile, leading to more stability. Always regression test the site if upgrading packages, as they may contain breaking changes. @@ -82,6 +117,6 @@ To better display the components available on the site, their properties, and th ## [Release Please](https://github.com/googleapis/release-please) -- Release Please automates CHANGELOG generation, the creation of GitHub releases, and version bumps for your projects. +- Release Please automates CHANGELOG generation, the creation of GitHub releases, and version bumps for your projects. - It is currently setup as a github action in this repo - See [documentation](https://github.com/googleapis/release-please) on how to use diff --git a/components/subfooter-form.vue b/components/subfooter-form.vue index d2fdb3e..58b0a61 100644 --- a/components/subfooter-form.vue +++ b/components/subfooter-form.vue @@ -130,7 +130,7 @@ const submitForm = async () => { } else { fieldError.value = true } - buttonStore.set({id: 'subfooter-card-newsletter-signup', loading: false}) + buttonStore.setButton({id: 'subfooter-card-newsletter-signup', loading: false}) }