Add info for getting an app install on local env #2
Conversation
oauth-express/README.md
Outdated
| @@ -26,7 +26,7 @@ | |||
|
|
|||
| Place cert in `example.com.pem` & `example.com-key.pem` | |||
|
|
|||
| 6. Start server | |||
| 6. Start the server. If developing locally, change the KIT_SERVER from `kit.com` to `ck.lol` on this [line](https://github.com/Kit/app-demos/blob/0c86c93c34bf5c7b47bb170b6a12dbda31d88e6f/oauth-express/kit-oauth.js#L4). | |||
There was a problem hiding this comment.
I think instead of stating to change this on this step I recommend we update step 3 to have KIT_SERVER=ck.lol in the .env
| @@ -4,14 +4,14 @@ | |||
|
|
|||
| ## 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. | |||
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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"
In order to work on the manage tab for the new /apps page, I needed apps to manage. This repo helps with authorization and installing an app, but it was not clear on how to set it up for local development.
If there should be a separate section or different wording, let me know.