Skip to content

Commit

Permalink
📝 Updated docs fro contributions
Browse files Browse the repository at this point in the history
  • Loading branch information
naelob committed Jun 25, 2024
1 parent dd15004 commit e1b87c2
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 20 deletions.
32 changes: 16 additions & 16 deletions docker-compose.dev.yml
Original file line number Diff line number Diff line change
Expand Up @@ -235,22 +235,22 @@ services:
volumes:
- .:/app

ngrok:
image: ngrok/ngrok:latest
restart: always
command:
- "start"
- "--all"
- "--config"
- "/etc/ngrok.yml"
volumes:
- ./ngrok.yml:/etc/ngrok.yml
ports:
- 4040:4040
depends_on:
api:
condition: service_healthy
network_mode: "host"
#ngrok:
#image: ngrok/ngrok:latest
#restart: always
#command:
# - "start"
# - "--all"
# - "--config"
# - "/etc/ngrok.yml"
#volumes:
# - ./ngrok.yml:/etc/ngrok.yml
#ports:
#- 4040:4040
#depends_on:
# api:
# condition: service_healthy
#network_mode: "host"

docs:
build:
Expand Down
13 changes: 9 additions & 4 deletions docs/open-source/contributors.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,16 @@ We made a docker file that builds Panora from sources, specifically to help you
```bash
rm -rf node_modules .pnpm-store ./packages/api/dist ./packages/api/node_modules ./apps/webapp/node_modules ./apps/frontend_snippet/node_modules
```
<Info>For Mac users only: <br/>
```bash
echo -e "node-linker=hoisted\n package-import-method=clone-or-copy" > .npmrc
```
<Info/>
</Step>
<Step title="Mac Users only:">
```bash
echo -e "node-linker=hoisted\n package-import-method=clone-or-copy" > .npmrc
```
<Step title="(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`): <br/>
- Add your auth token and domain from your Ngrok dashboard to the `ngrok.yml` file.<br/>
- Uncomment the Grok service inside the `docker-compose.dev.yml` file.
</Step>
<Step title="Start the Dockerfile">
```bash
Expand Down

0 comments on commit e1b87c2

Please sign in to comment.