feat: add docker compose for pg db, pgadmin and ngrok

HamedMP / CursorLens

An open-source dashboard for Cursor.sh IDE. Log AI code generations, track usage, and control AI models (including local ones). Run locally or use upcoming hosted version.

https://www.cursorlens.com

GNU Affero General Public License v3.0

138 stars 22 forks source link

feat: add docker compose for pg db, pgadmin and ngrok #7

Open gruckion opened 2 months ago

gruckion commented 2 months ago

… scripts

Introduces a docker compose to provision a local pg database and a make file. make up to spin up the pg database.
Also introduces prisma alias scripts in package.json. pnpm db:push for getting the local db ready.
Added ngrok to the docker-compose and update the readme.

CleanShot 2024-08-20 at 10 17 36@2x

Users now only need to run;

❯ make up
❯ make ngrok-url
Fetching ngrok URL...
https://00a0-000-000-0-000.ngrok-free.app

And it reads the API key from .env

NGROK_AUTHTOKEN=

HamedMP commented 2 months ago

This is very nice! And thanks for the comment, I think it is nice to make it easier for people start using it with less effort.

Question: Can we setup the ngrok inside the container too?

HamedMP commented 2 months ago

For #1

gruckion commented 2 months ago

This is very nice! And thanks for the comment, I think it is nice to make it easier for people start using it with less effort.

Question: Can we setup the ngrok inside the container too?

Yes we can,

https://ngrok.com/docs/using-ngrok-with/docker/

Done.

gruckion commented 2 months ago

Ready for review.

HamedMP commented 2 months ago

Just added #11 in case we don't want too much to be bound to ngrok.

This might be a separate issue/PR to migrate from ngrok, but at least to mention it as related. Signing up in ngrok is a barrier.

If we can use a CursorLens app on CF to generate a URL for the user, that'd be 🔥