search

unkeyed / unkey

Open source API management platform
https://go.unkey.com
Other
4k stars 467 forks source link

[docs] Contributors are required to use paid PlanetScale plan. Can we use a planetscale proxy? #1593

Closed clmnin closed 5 months ago

clmnin commented 5 months ago

Type of documentation issue

Other

Describe the problem and the proposed solution

Planetscale removed their Hobbie plan - link

How can I run unkey locally?

I see you are running a planetscale proxy (this one) while testing the api. Can we migrate the contributing doc to use a something similar?

If it is possible, I can make the necessary changes with a bit of guidance.

linear[bot] commented 5 months ago

ENG-1055 [docs] Contributors are required to use paid PlanetScale plan. Can we use a planetscale proxy?

perkinsjr commented 5 months ago

Hey there!

I am working on the documentation refresh right now but you can do this by doing the following:

Checkout Unkey and have Docker running

pnpm i
pnpm local

Choose what part you want to work on and follow the instructions.

The new documentation should be ready in the next day or so.

revogabe commented 5 months ago

I was going to work on the dashboard and I noticed this too, thanks for opening this issue, I needed to know if there was any way to run it locally

perkinsjr commented 5 months ago

The documentation has been updated to reflect our new local development environment.