DiscordCards

KO | EN

gitlite — search

#php #javascript #python #game #c-sharp #hacktoberfest #c-plus-plus #theme #ruby #ios #golang #slack

★ 21 Open GitHub ↗

Discord activity cards for github readme / your personal websites

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<div align="center">
 <h3 align="center">Discord Cards</h3>

An awesome way to display your discord activity !
 
 <a href="https://github.com/crizmo/DiscordCards/blob/main/server-dcez/README.md">Explore more »</a>
 
 <a href="https://github.com/crizmo/DiscordCards/tree/main/server-dcez">Server Side</a>
 ·
 <a href="https://github.com/crizmo/dcez-client">Client Side</a>
 ·
 <a href="https://discord-cards.vercel.app/">Website</a>
 
 <img src="https://discord-cards.onrender.com/api/compact/784141856426033233?about=Exploring&banner=https://staticg.sportskeeda.com/editor/2022/10/72d24-16655552144135-1920.jpg" />
 
 <a href="https://ko-fi.com/kurizu" target="_blank">
 <img src="https://ko-fi.com/img/githubbutton_sm.svg" alt="Support me on Ko-fi" />
 </a>

</div>

<details>
 <summary>Features</summary>
 <ol>
 <li>
 <a href="#about-the-project">About The Project</a>
 </li>
 <li><a href="#usage">Usage</a></li>
 <li><a href="#roadmap">Roadmap</a></li>
 <li><a href="#issues">Issues</a></li>
 <li><a href="#contributing">Contributing</a></li>
 <li><a href="#license">License</a></li>
 <li><a href="#contact">Contact</a></li>
 </ol>
</details>

## About The Project

Discord Cards helps you display your discord activity on your website / anywhere you want using the api or the client.

Here's what Discord Cards offer:
* client (website): display your discord activity on the website
* server (backend): display your discord activity as a api image which u can use on your website or anywhere you want

(<a href="#top">back to top</a>)

## Usage

Discord Cards is very easy to use.
You can either use the api endpoint to display your discord activity or get your discord activity using the Discord Cards client website.

You can display your discord activity as a card or a compact card.
The endpoint are the following:
<a href="https://discord-cards.onrender.com/api/card/:id">User card large</a> 
<a href="https://discord-cards.onrender.com/api/compact/:id">User card compact</a> 
Replace :id with your discord id + you can add the optional queries too.
The queries are:

* banner: url of the banner image
  * hex: hex color for alternative banner color [ ?hex=D0D1D1 ]
  * about: about the user
  * type: discord activity type

* large_image: url of the large image
  * small_image: url of the small image
  * side_image: url of the side image

large_image, small_image , side_image are basically the activity images.

<a href="https://discord-cards.onrender.com/">API</a>
<a href="https://discord-cards.vercel.app/">Website</a>

(<a href="#top">back to top</a>)

## Roadmap

- [x] Better client website
- [x] Update svg cards
- [ ] Add more cards for different discord activities
- [x] Endpoints
- [x] Better way for contributors to contribute
- [x] Fix (&) in spotify name bug

(<a href="#top">back to top</a>)

## Issues

If you have any issues with the api or the client website, please open an issue on the github repo.

(<a href="#top">back to top</a>)

## Contributing

Any contributions you make are **greatly appreciated**.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request

(<a href="#top">back to top</a>)

## License

Distributed under the MIT License. See `LICENSE.md` for more information.

(<a href="#top">back to top</a>)

## Contact

You can contact me on Discord my username is `x_kurizu`.

(<a href="#top">back to top</a>)

DiscordCards

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README