diff --git a/.env.example b/.env.example index 1c7d6d2..e388465 100644 --- a/.env.example +++ b/.env.example @@ -1,2 +1,4 @@ -FINDER_GITHUB_CLIENT_ID= +FINDER_GITHUB_CLIENT_ID= #https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app FINDER_GITHUB_CLIENT_SECRET= + +GH_TOKEN= ##https://github.com/settings/tokens \ No newline at end of file diff --git a/README.md b/README.md index 21b01fa..70a9193 100644 --- a/README.md +++ b/README.md @@ -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`. diff --git a/Screenshot from 2024-05-07 08-36-33.png b/Screenshot from 2024-05-07 08-36-33.png new file mode 100644 index 0000000..b2177e3 Binary files /dev/null and b/Screenshot from 2024-05-07 08-36-33.png differ