This repository has been archived in favour for the new Bento website repository
This website is for Bento 🍱 a Discord bot with server moderation tools and various entertaining commands.
The Bento 🍱 website is written in TypeScript and powered by the React Framework Next.js, with CSS from tailwindcss, and a PostgreSQL database.
-
About page that explains the background for the Discord bot and what technologies are used
-
Support page that shows Patrons on Patreon and how this project uses support
-
Setup page that shows what happens when the bot joins a server and what to do
-
Commands page that shows a list of all Bento commands, some with practical examples.
-
Leaderboard page that shows the global leaderboard for Bento
-
Dynamic route for the leaderboard page, that shows the leaderboard for a server.
- A PostgreSQL Database, or any database where you can store total user count, total server count, and global leaderboard data (perhaps per server too if you want to support dynamic routing).
- Either locally run/install PostgreSQL or get a PostgreSQL database elsewhere. Other SQL databases may be possible considering Bento uses Sequelize, but it is not tested and isn't recommended because the code may use PostgreSQL specific features, and it requires additional changes to the code. May be possible to use NoSQL with refactoring of code.
- The creation of the database tables. An SQL DDL schema file can be found here
git clone https://github.com/thebentobot/bento-web.git
or download ZIP.npm install
assuming you have installed node.js- Create a dotenv file with the environment variables:
DBdatabase=[NAME OF YOUR DATABASE]
,DBusername=[NAME OF YOUR DATABASE user]
,DBpassword=[PASSWORD FOR YOUR DATABASE USER]
andhost=[IP FOR YOUR DATABASE]
npm run build
npm start
This website is mainly developed by Christian.
Pull requests are very welcome if the features/changes makes sense and are up to par in quality.
This project is licensed under the AGPL-3.0 License
The avatar illustration is done by Freepik.