Ever wanted an easy-to-setup front homepage for your discord bot?
TSCord Websiteis here for you!
This Next.js full static website is meant to be used with a bot created from the tscord bot template.
- "Add to Discord" button
- Stats of the bot (such as total users, guilds, etc)
- List of commands
- Markdown articles
- Responsive
- Animations
- Full static
- ...and many more!
tscord-website.preview.mp4
- Click on the use this template button
- Clone your newly created repo
- Fill the
.env.examplewith the API URL and API key of your tscord based bot and then rename it.env - Fill the
config.jsonas you want - Make sure your bot is running and that the API is accessible
- Run
npm run build
Then you have two options for the deployment:
-
Just run
npm run startand you will be able to access the website using the port of the next.js server. This is the simpliest way to run the website, and it will enable ISR on the website, which permit to keep the advantage of a static website while refreshing the data and rebuilding automaticaly individual pages every X time (by default: 12 hours). But the main downside is the need of a next.js server instance to be running 24/7. -
The other solution is to run
npm run export, which will create a full static version of the website with no need of a next.js server instance to run in the background. This command exports the website in theoutdirectory, and you'll next have the choice of deploying this directory anywhere you want (e.g: Github Pages, CDN, the/var/wwwfolder of your private server, etc).In this solution, and as a contrast with the other, the main downside is that you'll have to re-build and re-deploythe website each time your data (list of commands, articles, etc) change. You can still resolve this by automating all of this with a well configured CI/CD ecosystem (e.g: Github Actions, cron jobs on your server or on your bot, etc). It will take you more effort for sure, but will result in the best of the two solutions!