https://github.com/crizmo/discordcards

Discord activity cards for github readme / your personal websites
https://github.com/crizmo/discordcards

badges card discord express github readme-profile rpc server socket-io

Last synced: about 1 month ago
JSON representation

Discord activity cards for github readme / your personal websites

• Host: GitHub
• URL: https://github.com/crizmo/discordcards
• Owner: crizmo
• License: mit
• Created: 2022-06-11T05:21:04.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-12-13T18:32:47.000Z (about 1 year ago)
• Last Synced: 2023-12-14T19:03:14.758Z (about 1 year ago)
• Topics: badges, card, discord, express, github, readme-profile, rpc, server, socket-io
• Language: JavaScript
• Homepage: https://discord-cards.vercel.app/
• Size: 409 KB
• Stars: 16
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: ChangeLog.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
Note: If you are already using discord cards else ignore this note
Update your discord cards url from https://discord-cards.kurizu.repl.co/ to https://discord-cards.onrender.com/




  
Discord Cards


  


    An awesome way to display your discord activity !

    


    Explore more »

    


    Server Side

    ·

    Client Side

    ·

    Website

  

  



  Features

  


    


      About The Project

    

    
Usage

    
Roadmap

    
Issues

    
Contributing

    
License

    
Contact

  


## 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

(back to top)


## 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:

User card large 


User card compact 


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.

API

Website

(back to top)


## 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

(back to top)


## Issues

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

(back to top)


## 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

(back to top)


## License

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

(back to top)


## Contact

You can contact me on Discord my username is `kurizu.taz`.

(back to top)