diff --git a/internal-docs/engineering/developing-locally.md b/internal-docs/engineering/developing-locally.md index 9a28a8570f..b1c86e9719 100644 --- a/internal-docs/engineering/developing-locally.md +++ b/internal-docs/engineering/developing-locally.md @@ -13,6 +13,7 @@ - [Working on components](#working-on-components) - [Working on the docs site](#working-on-the-docs-site) - [Working on Remix (Theme Designer)](#working-on-remix-theme-designer) + - [Working on Backend](#working-on-backend) ## Prerequisites @@ -300,3 +301,72 @@ Then run: ```bash yarn start:theme-designer ``` + +## Working on Website Backend + +This section covers how to setup the Supabase backend and + +### Prerequisites + +You will need docker or a similar service in odrer to start the local supabase instance. + +### Environment + +To run the backend and develop all functionality of the website you will need to add additional variable in the `.env` file previously configured + +**Note**: access can be granted internally to OpenAI via the Service portal + +
OPENAI_API_KEY + | +The token used to interact with OpenAI + | +
OPENAI_API_SECRET + | +The secret provided by OpenAI + | +
OPENAI_ASSISTANT_ID + | +The assistant id for the OpenAI project + | +
SUPABASE_URL + | +The url of the supabase BE you want to use. For local development is should map to http://127.0.0.1:54321 + | +
SUPABASE_KEY + | +This will be generated and output from the start command in `/apps/backend`. It can also be retreieved by running `npx supabase status` in the directory. + | +
GH_SERVICE_ACC_DISCUSSIONS_TOKEN + | +Used for embeddings script, must be a token with read access to Paste repo discussions. + | +
ROLLBAR_ACCESS_TOKEN + | +A dummy value can be used for local development e.g. "MOCK_TOKEN" + | +