Skip to content

hideko-dev/Thundis

Repository files navigation





Thundis

Powerful Rest API to get Discord user status

Explore the docs
Homepage · Pull Requests · Issues



Overviews

  1. About
  2. Usage
  3. Stack
  4. JS Module
  5. Developer

About

This repository is a nodejs-based server with a Rest API that allows you to get detailed user information about people who are in the Discord server.

Why use this?

  • API acquisition is fast and can be used immediately without the need to create an account.

  • You can retrieve the maximum content that can be retrieved from Discord's API.

  • It is completely open source and can respond to user requests.

  • To learn more, please visit the project's official website.

Stacks

  • Node.js (Creation of servers, used for engines)
  • Express (Used to create Rest API)
  • Discord.js (Used to use Discord's API)
  • Cors (Used to counteract browser blocking of Cors)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

  • To begin with. Be sure to install the npm module.
npm install
  • Edit environment file (.env)

By default, it looks like this. ```dotenv BOT_TOKEN= SERVER_ID= PORT_NUMBER= DEBUG_CHANNEL_ID= ```

Tip

"DEBUG_CHANNEL_ID" is a code that logs API requests and server errors. It may not be used.

for Developer

Hello World

(back to top)

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

(back to top)

Roadmap

  • Add Changelog
  • Add back to top links
  • Add Additional Templates w/ Examples
  • Add "components" document to easily copy & paste sections of the readme
  • Multi-language Support
    • Chinese
    • Spanish

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. 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.txt for more information.

(back to top)

Contact

Your Name - @your_twitter - email@example.com

Project Link: https://github.com/your_username/repo_name

(back to top)

Acknowledgments

Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!

(back to top)