Skip to content

Add info for getting an app install on local env #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add info for getting an app install on local env #2

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8ee49eb
add info for getting an app to install on local environments
erinfox Feb 7, 2025
9803956
update step 3
erinfox Feb 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions oauth-express/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,18 @@

## Usage

1. First you must create your app inside the Kit Developer Settings
1. First you must create your app inside the Kit Developer Settings. If developing locally, you can create the app in the main Kit repository.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i'm not entirely following what we mean here by create in the main kit repository? are we referring to creating on the locally running app.ck.lol server?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Correct.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hm. I feel we should strike a balance here. This repository is public so that other developers can see how to create an app and so the documentation was written from the perspective of someone who doesn't have a local kit server running, hence the direct "inside the Kit Developer Settings".

I'd recommend we change the step three again to explain the alternative path to take if you're a Kit engineer vs a developer. What do we think about something like this?

3. Create .env file and add the client ID and secret from the Developer Settings:

 KIT_OAUTH_CLIENT_ID="FILL ME IN"
 KIT_OAUTH_CLIENT_SECRET="FILL ME IN"
 # Kit Engineers: If you're running your own Kit server locally, you'll want to change the server used
 # KIT_SERVER="ck.lol"


2. Then configure API Access:

Authorization URL: https://localhost:8080/oauth/kit
Redirect URI: https://localhost:8080/oauth/kit/callback

3. Create `.env` file and add the client ID and secret from the Developer Settings:
3. After cloning this repository, create an `.env` file and add the client ID and secret ID from the Developer Settings. Set the KIT_SERVER if needed:

KIT_OAUTH_CLIENT_ID="FILL ME IN"
KIT_OAUTH_CLIENT_SECRET="FILL ME IN"
KIT_SERVER=ck.lol

4. Install dependencies

Expand Down Expand Up @@ -42,5 +43,4 @@
}
Listening on :8080

7. From here, clicking the "Install" button in the App Store will initiate the OAuth flow
by first going to your configured Authorization URL
7. From here, clicking the "Install" button in the App Store will initiate the OAuth flow by first going to your configured Authorization URL