Companion Site

This repo is the monorepo for the companion website.

Authors

Josh Ellis josh@companion.studio

Environments

Make a list of the ENVs we have

• Staging – https://companion-studio-eta.vercel.app/

Developing

Built With

• Nextjs
• Stitches
• React
• react-spring

Prerequisites

• Node 16.13.0 (theres an nvm file)
• Yarn >=3
• Doppler

Setting up Dev

Here's a brief intro about what a developer must do in order to start developing the project further:

yarn

doppler login

yarn web:dev

Deploying / Publishing

There's an automatic pipeline from pushing to main to the vercel deployment.

Versioning

We use SemVer for versioning. For the versions available, see the link to tags on this repository.

Documentation

Create a small list like below to link to parts of your documentation wherever they are (they're probably in notion)

• API Reference