From fbe9192230d8789832c940f0cd6569f423ad8b05 Mon Sep 17 00:00:00 2001 From: Andrei Jiroh Halili Date: Thu, 18 Jul 2024 00:12:06 +0800 Subject: [PATCH] docs(golinks): update development docs and add one for reviewers Signed-off-by: Andrei Jiroh Halili --- apps/golinks-v2/README.md | 9 +++++---- apps/golinks-v2/docs/hackclub-arcade.md | 22 ++++++++++++++++++++++ 2 files changed, 27 insertions(+), 4 deletions(-) create mode 100644 apps/golinks-v2/docs/hackclub-arcade.md diff --git a/apps/golinks-v2/README.md b/apps/golinks-v2/README.md index bce3e82..56df86a 100644 --- a/apps/golinks-v2/README.md +++ b/apps/golinks-v2/README.md @@ -13,9 +13,10 @@ powered by [chanfana](https://github.com/cloudflare/chanfana) and ## Development -1. After running `yarn`, run `yarn types:gen` to generate Prisma client types. Don't forget to sign into Wrangler CLI via `yarn wrangler login`. -2. Run migrations to init things: `yarn migrations:apply --local` -3. Run local dev server: `yarn dev` -4. Once everything up, open the Swagger-generated API docs at [^1] and happy hacking. +1. Run `yarn` to install dependencies and generate Prisma client code with `yarn types:prisma-client`. +2. Sign in with Cloudflare for Wrangler CLI: `yarn wrangler login` +3. Run migrations to init things: `yarn migrations:apply --local` +4. Run local dev server: `yarn dev` +5. Once everything up, open the Swagger-generated API docs at [^1] and happy hacking. [^1]: Look for port `35120` on Ports if you're on a remote dev environment, especially for GitHub Codespaces and Gitpod users. diff --git a/apps/golinks-v2/docs/hackclub-arcade.md b/apps/golinks-v2/docs/hackclub-arcade.md new file mode 100644 index 0000000..a70c834 --- /dev/null +++ b/apps/golinks-v2/docs/hackclub-arcade.md @@ -0,0 +1,22 @@ +# Documentation for Hack Hour / Arcade Reviewers + +## Local Development + +[See the README](../README.md#development) for instructions on how to locally run the golinks server. + +## Testing the staging deployment + +The API production environment at is currently reserved for personal use, +so it is preferred to + +1. Go to to access the Swagger UI. +2. Select the `Staging Deployment` from the list of servers. + +![](https://files.slack.com/files-pri/T0266FRGM-F07CEURPSGP/image.png?pub_secret=2faa123191) + +3. Now you can test the API. For routes that require authenication, use the following +API key for the `X-Golinks-Admin-Key` header. + +``` +gostg_hackclub-7yIz7ZgIy7eS9LI2KId1WxdgBisVXTKGBvuLBroIXVBqS9U9 +``` -- 2.51.2