getting-started-manual.md

Getting Started

• Prerequisites
• Installing
  • 1. Create Google OAuth consent screen and Client Secret
  • 2. Enable APIs
  • 3. Create Slack Webhooks
  • 4. Run
  • 5. Access prel

Prerequisites

• 2 Google Account
• Google Cloud
• Go
• Docker
• Slack

Installing

1. Create Google OAuth consent screen and Client Secret

Follow the instructions on this page to create an OAuth web client ID:

• Create the OAuth web client ID

When creating the client ID, register the following two URLs:

• http://localhost:8181
• http://localhost:8181/auth/google/callback

If setting the OAuth consent to external for testing, register the two Google Accounts you will use.

Then, obtain the Client ID and Client Secret.

2. Enable APIs

• Cloud Resource Manager API
• Identity and Access Management (IAM) API

3. Create Slack Webhooks

• Sending messages using Incoming Webhooks | Slack

Then, obtain the incoming_webhook_url.

* If you don't use slack, please skip.

4. Run

Please log in in advance.

gcloud auth login

gcloud auth application-default login

Run application.

ADDRESS=127.0.0.1 \
PORT=8181 \
PROJECT_ID=[YOUR_GOOGLE_PROJECT_ID] \
NOTIFICATION_URL=[INCOMING_WEBHOOK_URL] \
CLIENT_SECRET=[CLIENT_SECRET] \
CLIENT_ID=[CLIENT_ID] \
DB_PASSWORD=password \
make run

* if you don't use slack, delete NOTIFICATION_URL=[INCOMING_WEBHOOK_URL] \

After starting the database and app.

Running...
[+] Building 0.0s (0/0)                       docker:desktop-linux
[+] Running 2/2
 ✔ Network prel_default  Created                              0.0s
 ✔ Container prel-db-1   Started                              0.0s
Running...
{"time":"2023-12-23T15:13:42.064352+09:00","severity":"INFO","caller":"/tmp/prel/cmd/prel/main.go:122","message":"Server started on 127.0.0.1:8181"}

5. Access prel

Access to http://localhost:8181