CATcher-org / CATcher-org/CATcher

Including documentation for setting up GitHub application and Gatekeeper

Open
#1,263 1 comment 0 reactions 0 assignees View on GitHub
aspect-Documentation category.Feature
Dominant language
TypeScript
Stars
92
Forks
85
PR merge metrics
No merged PRs in 30d

Description

**Is your feature request related to a problem? Please describe.**

The current CATcher documentation is relatively sparse on how to setup the full application for dev mode. It took me a while to realize what was all required.

**Describe the solution you'd like**

The key points to note are:

1. Setting up a GitHub application with a custom client id
2. Setting up Gatekeeper locally
3. Modifying/adding an environment file with the custom client id, gatekeeper redirect URL, and client data URL

**Describe alternatives you've considered**

Alternatively, dockerize both CATcher and Gatekeeper to launch on 2 separate ports but so they are all bundled for dev purposes. This is mostly because the environment is hardcoded to a few values which may not be entirely accurate for dev.

**Additional context**

N/A

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with CATcher's current developer setup documentation and inspect how the environment file is loaded. Document the required custom GitHub application client ID, local Gatekeeper setup, redirect URL, and client data URL; done means a newcomer can follow the steps to run CATcher in dev mode.

Written by the indexing model from the issue text.

Assessment

Tech stack
github, typescript
Domain
developer-experience, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.