Skip to content
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

fix: A bug fix in readme, link to discord was not clickable #142

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: A bug fix in readme, link to discord was not clickable #142

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 4 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ In this manual we'll walk you through the steps you need to take to get oss.gg a
4. Start the local instance of oss.gg with your GitHub test app and install oss.gg on test repository

## 1. GitHub Personal Access Token

In the development environemnt we're using Personal Access Tokens to query the GitHub API. This is neccessary because the rate limit of GitHub can be quite strict so we need to decentralize the request amount:

<img width="1145" alt="image" src="https://github.com/formbricks/oss.gg/assets/72809645/56674a44-29b8-4297-9048-4974b50921ce">
Expand All @@ -21,6 +22,7 @@ Generate one and fill it in the env variable:
Let's setup your oss.gg GitHub App 👇

## 2. oss.gg Github App Setup

You need to create your own GitHub app to test the oss.gg functionality you're developing and to make the GitHub SSO work locally:

Stay in your GitHub Account Settings -> Developer Settings -> GitHub Apps and Create a New App:
Expand Down Expand Up @@ -122,8 +124,9 @@ The `NEXTAUTH_SECRET` you can generate with the command written in the command b
```

## 4. Start the local instance of oss.gg with your GitHub test app and install oss.gg on test repository

Please follow this video: https://youtu.be/KkKwqcw-h-k

#Got stuck?

Please join our Discord and let us know so we can update this guide 🤓: oss.gg/discord
Please join our Discord and let us know so we can update this guide 🤓: https://oss.gg/discord
Loading