⚠️ Universe List Release!Our fantastic team has just recently released Universe List, which means that there WILL BE many bugs. Join our Discord Server or Email Us to report any issues / bugs!
Installation
This is for users who want to contribute to Universe List, or even run a self hosted instance of Universe List.
- Download the code. In the web version of GitHub, you can do that by clicking the green "Code" button, and then "Download ZIP".
- Unzip it, and open it in code.
- Run the command
npm i
in the terminal. - Fill out the
.env.template
file with your information, and then rename the file to.env
. - Fill out the information in the
config.js
file. - Go to the Discord Developer Portal and go to the main bot.
- Go to the
0Auth2
section and set the following URLs underRedirects
.
・ https://example.com/auth/callback
・ https://example.com/auth/callback/joinSupport
Make sure to changeexample.com
with your domain. - 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 this
- 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
- Bot Re-submit Option
- Website Themes
- Optimize the code
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.