Skip to content

Add Discord local Discord OAuth setup guide to README - #569

Closed
MingJae92 wants to merge 2 commits into
Together-100Devs:mainfrom
MingJae92:docs/discord-oauth-setup
Closed

Add Discord local Discord OAuth setup guide to README#569
MingJae92 wants to merge 2 commits into
Together-100Devs:mainfrom
MingJae92:docs/discord-oauth-setup

Conversation

@MingJae92

@MingJae92 MingJae92 commented Jun 18, 2025

Copy link
Copy Markdown

Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. Additionally, please include reasoning if tests have failed.

Type of change

Please select everything applicable. Please, do not delete any lines.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update
  • This change requires an update to testing

Issue

  • Is this related to a specific issue? If so, please specify:

Checklist:

  • This PR is up to date with the main branch, and merge conflicts have been resolved
  • I have executed npm run test and npm run test:e2e and all tests have passed successfully or I have included details within my PR on the failure.
  • I have executed npm run lint and resolved any outstanding errors. Most issues can be solved by executing npm run format
  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • My changes generate no new warnings

Comment thread README.md
Comment thread client/README.md Outdated

@alcpereira alcpereira Jun 19, 2025

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This file was removed recently, it probably means that your branch is not up to date with upstream/main.

Comment thread client/README.md Outdated

@alcpereira alcpereira Jun 19, 2025

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Note that the issue explicitly ask you to edit the Wiki page, not a markdown file in the repo. You can keep the PR open so we can review the changes, but the final work needs to be done on the Wiki page (check the link in the issue).

Comment thread client/README.md Outdated
Comment thread client/README.md Outdated
Comment thread client/README.md Outdated

### 4. Update Your `.env` File

Create or update your `.env` file (in the root or `server/` folder):

@alcpereira alcpereira Jun 19, 2025

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

  • This is part of the docs regarding creating the .env, so "create or update" is not relevant
  • There is only a single correct place for the .env file, it is in server/.env

Comment thread client/README.md Outdated
Comment on lines +104 to +105
DISCORD_CLIENT_ID=your_client_id_here
DISCORD_CLIENT_SECRET=your_client_secret_here

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Please use markdown here.

Comment thread client/README.md Outdated

![Create new Discord app](./docs/images/discord-new-app.png)

### 2. Configure OAuth2

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Suggested change
### 2. Configure OAuth2
### 2. Configure OAuth2 redirect

Comment thread client/README.md Outdated
- Click **Save Changes**.

![Set redirect URI](./docs/images/discord-redirect-uri.png)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Might be worth a short explanation about what is this redirect and why it is important.
Maybe a link to an article or something?

This is relevant for all apps using OAuth and Together is a learning project, so it will be beneficial for everyone reading this wiki.

Comment thread client/README.md Outdated

### 3. Retrieve Your Credentials

- Go to the **General Information** tab.

@alcpereira alcpereira Jun 19, 2025

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This is not in the General Information tab

@MingJae92

Copy link
Copy Markdown
Author

I think I have added some changes. There should be a READ updates plus two images. @alcpereira

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

The URL is incorrect

Comment thread server/.env.example

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This change is not needed

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

Resolved!

Comment thread Together Outdated
@MingJae92
MingJae92 force-pushed the docs/discord-oauth-setup branch 4 times, most recently from 2d5a89b to cc1638b Compare June 21, 2025 00:37
@MingJae92
MingJae92 force-pushed the docs/discord-oauth-setup branch from cc1638b to b65e901 Compare June 21, 2025 01:07
@DevinCLane

Copy link
Copy Markdown
Collaborator

any updates on this @MingJae92?

@MingJae92

Copy link
Copy Markdown
Author

Sorry, I have been swamped by lots of work. I can hand this over to someone else.

@DevinCLane

Copy link
Copy Markdown
Collaborator

closing this as @dan-foley is taking this one in #567

@DevinCLane DevinCLane closed this Aug 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants