@@ -173,23 +173,19 @@ Follow these steps to run the application in your local environment:
173173 npm i
174174 ```
175175
176- 3 . If you're working with features regarding anything database related, you need
177- to set up your environment variables locally and create a Github MongoDB
178- Atlas cluster and an AWS S3 bucket. If you're working with some other
179- features, you can skip this step.
180-
181- First, make a copy of the ` .env.local.example ` file and rename it to
182- ` .env.local ` .
176+ 3 . Set up your environment variables locally. Make a copy of the
177+ ` .env.local.example ` file and rename it to ` .env.local ` .
183178
184179 ``` bash
185180 cp .env.local.example .env.local
186181 ```
187182
188183 You will need to replace the placeholder values in this file with your actual
189- credentials.
184+ credentials:
190185
191- - For Github you need to replace ` GITHUB_ID ` and ` GITHUB_SECRET ` with your on
192- credentials by creating a GitHub OAuth Application:
186+ - For GitHub authentication, you need to replace ` GITHUB_ID ` and
187+ ` GITHUB_SECRET ` with your own credentials by creating a GitHub OAuth
188+ Application:
193189
194190 - Go to your GitHub account settings.
195191 - Navigate to "Developer settings" > "OAuth Apps" > "New OAuth App."
@@ -200,6 +196,25 @@ Follow these steps to run the application in your local environment:
200196 After registering the application, you will receive a client ID and client
201197 secret.
202198
199+ - For GitHub API access, you need to create a personal access token:
200+
201+ - Go to your GitHub account settings.
202+ - Navigate to "Developer settings" > "Personal access tokens" > "Tokens
203+ (classic)" > "Generate new token".
204+ - Select the necessary scopes (at minimum: ` repo ` , ` read:user ` ,
205+ ` user:email ` ).
206+ - Copy the generated token and use it for ` GITHUB_TOKEN ` ,
207+ ` FCM_GITHUB_TOKEN ` , and ` NEXT_PUBLIC_GITHUB_TOKEN ` .
208+
209+ - For Clerk authentication, you need to create a Clerk account and get your
210+ API keys:
211+
212+ - Sign up at [ Clerk.dev] ( https://clerk.dev/ ) .
213+ - Create a new application.
214+ - Get your publishable key and secret key from the Clerk dashboard.
215+ - Replace ` NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY ` and ` CLERK_SECRET_KEY ` with
216+ your actual keys.
217+
203218 - You also need to replace NEXTAUTH_SECRET with a random string. You can
204219 generate one simply in terminal:
205220
0 commit comments