Setup an existing project

Work in Progress

What is it?

This doc is meant to install a project which is already in development/live. It will help you to start up the project on your local machine. Are you looking for the docs to create a new project?

Setup a new project

Set Up a New Project

1. Navigate to GitHub and locate the project repository
2. Clone the repository using SSH or GitHub CLI
3. (New projects only) Obtain the .env file from 1Password and place it in the root directory. Normally named: {{ projectName }} - Local .env
4. Execute yarn setup to install dependencies
5. Navigate to apps/cms and run yarn develop, then in a separate terminal, navigate to apps/web and run yarn dev
6. You’re ready to start development!

Set Up an Existing Project

1. Navigate to GitHub and locate the project repository
2. Clone the repository using SSH or GitHub CLI
3. (New projects only) Obtain the .env file from 1Password and place it in the root directory. Normally named: {{ projectName }} - Local .env
4. Access Rootnet and search for the project using “CMS” in the name
5. Copy the SSH connection details and open your terminal
6. Connect via SSH, run printenv, and copy the database information
7. Configure your database client (TablePlus or equivalent) with the copied information
8. Run yarn prepare && yarn build:cms to set up the project
9. Navigate to apps/cms and run yarn develop, then in a separate terminal, navigate to apps/web and run yarn dev