Skip to content

Latest commit

 

History

History
65 lines (52 loc) · 2.9 KB

README.md

File metadata and controls

65 lines (52 loc) · 2.9 KB
Raw

Universe List

The Ultimate Discord List for Bots and Servers!

Installation

This is for users who want to contribute to Universe List, or even run a self hosted instance of Universe List.

  1. Download the code. In the web version of GitHub, you can do that by clicking the green "Code" button, and then "Download ZIP".
  2. Unzip it, and open it in code.
  3. Run the command npm i in the terminal.
  4. Fill out the .env.template file with your information, and then rename the file to .env.
  5. Fill out the information in the config.js file.
  6. Go to the Discord Developer Portal and go to the main bot.
  7. Go to the 0Auth2 section and set the following URLs under Redirects.
    ･ https://example.com/auth/callback
    ･ https://example.com/auth/callback/joinSupport
    Make sure to change example.com with your domain.
  8. Start the project with npm start.

Terms of Use

  • You have the permission to shoot and share videos, but you have to mention us and our server in the video.
  • You cannot use our branding anywhere on your site & claim it as your own.
  • You have the permission to share in writing, but you have to mention us, our server, in the article.
  • You can't speak in a "we did it" way.
  • You cannot sell the code.
  • Don't touch this part on footer:
Copyright © 2023 Universe List, All Rights Reserved.

To-Do

Universe List is in a continuous state of development. New features/updates may come at any time. Some pending ideas are:

  • Bot Widgets.
  • Bots with uptime of less than 75% should be removed.
  • Co-owner feature to bots.
  • Add delete/edit/reply features for bot reviews.

Config

  • The domain variable should includes the protocol and doesn't end with a /. Eg, http://localhost:8080.
  • All the roles should be below the role of the bot that controls the list.
  • Most of the variables are Discord IDs.
  • The MongoDB URL can be either a local server or a remote one. Atlas provides a free tier with 500mb.
  • The minimum and maximum lengths for bot / server description and summary are in characters.

License

Released under the GNU GPL v3 license.

Contributors ✨