Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/markisdev/discordoauth

A simple, and easy to use, PHP implementation of a Discord OAuth2 login flow. Implements a "Login with Discord" button on your site. Use this repo to build your very own Discord Dashboard! 🚀
https://github.com/markisdev/discordoauth

discord discord-oauth oauth2

Last synced: 4 days ago
JSON representation

A simple, and easy to use, PHP implementation of a Discord OAuth2 login flow. Implements a "Login with Discord" button on your site. Use this repo to build your very own Discord Dashboard! 🚀

Host: GitHub
URL: https://github.com/markisdev/discordoauth
Owner: MarkisDev
License: mit
Created: 2017-05-17T07:34:28.000Z (over 7 years ago)
Default Branch: master
Last Pushed: 2023-01-22T15:01:53.000Z (almost 2 years ago)
Last Synced: 2024-12-12T04:11:57.581Z (11 days ago)
Topics: discord, discord-oauth, oauth2
Language: PHP
Homepage:
Size: 2.77 MB
Stars: 216
Watchers: 17
Forks: 57
Open Issues: 6
Metadata Files:
- Readme: readme.md
- License: LICENSE

Awesome Lists containing this project

README

Discord OAuth

An Open Source demonstration of a PHP Discord OAuth login flow, with multiple examples to build on top of.

Key Features •
How To Use •
Contributing •
Support •
License

## Key Features

* PHP sessions
* Get user data
- ID, Username, Avatar, Discrim etc.
* Get user connections
- Battlenet, Facebook, Github, Spotify, Twitter, Youtube etc.
* Get user guilds
- IDs, Icons, User permissions, Enabled guild features etc.
* Get guild user
- Nickname, Roles, Join date etc.
* Join user to guild
* Get guild object (requires bot)
* Give guild role (requires bot)
* ...and more!

## About

This is a small collection of demos, which you can use to start building your Discord PHP application from.

This is in no way a framework, but more a sort of *template* that you can use to build on top of.

The idea behind the repo is to give developers a nice starting point to further expand their application from. If you do end up expanding the possibilites of the script, be sure to check out [Contributing](#contributing) in this repo!

What is this **not**?
* This is not a library
* This is not a one-click installer
* This is not a final product

## How To Use

**Prerequisites:**
* [Git](https://git-scm.com) for cloning the repo
* [XAMPP](https://www.apachefriends.org/download.html) (or another web server) for running the PHP application
* [Discord Application](https://discord.com/developers/applications) with OAuth2 ``CLIENT ID`` and ``CLIENT SECRET``

Start by cloning this repository to your computer.

```bash
$ git clone https://github.com/MarkisDev/discordoauth
```
Now open up XAMPP Control Panel, and click on the `Config` button in the `Apache` module.

You want to search for "DocumentRoot", and change the values from ``C:/xampp/htdocs`` into the path of your `discordoauth` folder.

```bash
#
# DocumentRoot: The directory out of which you will serve your
# documents. By default, all requests are taken from this directory, but
# symbolic links and aliases may be used to point to other locations.
#
DocumentRoot "C:\WEB\discordoauth\demos"

```
> **Note**
> You may want to point the root directly to one of the included examples for ease of access (`C:\WEB\discordoauth\demos\simple-demo`).

Next you need to open the `config.php` file for the demo you wish to run.

*All demos included in this repo come with their own individual config-file. If you wish to try out multiple demos, you will need to edit the values in their respective `config.php` file.*

Fill out the config file as shown in the examples with values from [Discord Developers Dashboard](https://discord.com/developers/applications).

```php

> **Note**
> You can add multiple redirects to the same application, so feel free to also add the redirects for the other demos:

> `http://localhost/admin-dashboard/includes/login.php`

> `http://localhost/bot-dashboard/includes/login.php`

When you have done all the above steps, you should be able to visit [localhost/simple-demo](http://localhost/simple-demo) in your browser, and see the OAuth demo in action!

If you encounter any issues along the way, give us a visit in our [Discord Server](https://join.markis.dev), and we'll be sure to lead you back on the right track!

## Contributing

Contributions to the project are **always** welcome!

If you found a bug, please [open an issue](https://github.com/MarkisDev/discordoauth/issues/new/choose) and let us know.

If you have a request for a feature you can also [open an issue](https://github.com/MarkisDev/discordoauth/issues/new/choose) and we will take a look at it.

We accept [pull requests](https://github.com/MarkisDev/discordoauth/compare) for any fixes and/or new features.

If you want to contribute a new demo, please remember to copy any new Discord related functions to the `discord.php` file in the root of the repo.

## Support
**Support the Author here:**

**Support the Maintainer here:**

## License

[MIT License](https://mit-license.org/)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```
---

[@f-o](https://github.com/f-o) · [@markisdev](https://github.com/markisdev)