​
Introduction

​
Setup your environnement

We made a docker file that builds Panora from sources, specifically to help you locally test your contributions. Here’s how to use it.

Execute these from your Panora’s repo root folder
1

Copy env variables

Check environment variables reference here !
cp .env.example .env
2

Remove previously installed dependencies

rm -rf node_modules .pnpm-store ./packages/api/dist ./packages/api/node_modules ./apps/webapp/node_modules ./apps/frontend_snippet/node_modules
For Mac users only: echo -e "node-linker=hoisted\n package-import-method=clone-or-copy" > .npmrc
3

(Optional) Enable Grok

If you have to create an oAuth app for a provider and needs an https redirect uri you must enable Grok service and use your secure domain from them (it proxies requests to localhost:3000). Check this quick guide to set it up !

4

Start the Dockerfile

docker compose -f docker-compose.dev.yml up

That’s all ! You can find the backend and other services running at their usual location. Editing code locally will immediately reflect.

Was this page helpful?

Set up Ngrok2. Metadata