Skip to content
This repository has been archived by the owner on Sep 12, 2024. It is now read-only.

edit .env.example and update readme #410

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 3 additions & 1 deletion .env.example
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
FINDER_GITHUB_CLIENT_ID=<Your Github Client ID>
FINDER_GITHUB_CLIENT_ID=<Your Github Client ID> #https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app
FINDER_GITHUB_CLIENT_SECRET=<Your Github Secret>

GH_TOKEN=<Your-Super-Secret-Github-Token> ##https://github.com/settings/tokens
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,13 @@ Before installation, please make sure you have already installed the following t

We highly recommend installing the current LTS version of node.

6. Create a `.env` file in the root of the project. Then add your GitHub Oauth values (see example in `.env.example` file)
6.

Copy the `.env.example` file into a `.env` file using the following command.

```
cp .env.example .env
```

> **Note:** You need to set up an Oauth App(not GitHub App) in Github to get the required values. See the documentation [here](https://docs.github.com/en/developers/apps/building-oauth-apps/creating-an-oauth-app).
> The Callback Url needs to point to the endpoint of the baseURL the app should run on: `http://localhost:5173/api/authentication/callback`.
Expand Down
Binary file added Screenshot from 2024-05-07 08-36-33.png
Copy link
Member

Choose a reason for hiding this comment

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

Please delete this file

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.