Skip to content

Latest commit

 

History

History
66 lines (54 loc) · 2.38 KB

README.md

File metadata and controls

66 lines (54 loc) · 2.38 KB

Netlify badge
MPL-2.0 license badge Teacaps Instagram Teacaps Twitter

Installation

git clone [email protected]:teacaps/website.git
cd website
yarn install
yarn prepare

Development

yarn dev

The following environment variables are needed.
All Shopify environment variables can be obtained from the custom app.
Environment variables beginning with SES, used for mail, can be found upon creating an AWS IAM user (AmazonSESFullAccess policy is needed). Environment variables for ReCAPTCHA can be found upon creating a ReCAPTCHA v3 site.

Shopify Help Center: Custom apps
AWS IAM Management Console

ADMIN_API_TOKEN=...
ADMIN_API_VERSION=...
STOREFRONT_NAME=...
PUBLIC_STOREFRONT_API_TOKEN=...
PRIVATE_STOREFRONT_API_TOKEN=...
STOREFRONT_API_VERSION=...
SES_ACCESS_KEY=...
SES_ACCESS_KEY_ID=...
PUBLIC_RECAPTCHA_SITE_KEY=...
PRIVATE_RECAPTCHA_SECRET_KEY=...

Deployment

Pushing to main will automatically create a Vercel production deployment.

When a pull request is opened, a Vercel preview deployment will be automatically created.

To deploy from a local copy, run vercel in the project directory.

License

The Teacaps website is licensed under the Mozilla Public License, version 2.0. See the LICENSE file for more information.