What needs to be done before merging with production evie
-
Re-make the dashboard with Next.js instead of express
-
Everything that is possible with the dashboard should be able to be changed inside of Discord with Modals and slash commands
-
Re-write just about every typescript file as they were made when I was brand new to JavaScript and TypeScript so there's a lot of issues with them.
-
Moderation system
- Mod action log
- Mod notes
- Bans
- Kicks
- Warns
- User log
- Messages
- Nicknames
- Roles
- Mod action log
-
Add a tag system
Node.js
: To runyarn
Docker
: To be able to spin up a testing environment like productionyarn
: To manage dependencies
- Install yarn if you haven't done so yet,
npm i -g yarn
orsudo npm i -g yarn
if on a unix system. - Clone the repo, and switch to the
rewrite
branch. - Install deps with by typing
yarn
. - Fill in the
.env
file located inapps/bot
. - Go into the
apps/bot
directory.cd apps/bot
- Type
yarn build && npx prisma db push
- Code away.
- Test with
docker-compose up --build
this will spin up the Main container (the bot) and a local MongoDB container. - Push your changes.
- Make a PR.
If you need help with contributing to Evie or have any questions, please join the Discord server.
Evie is a completely free service and bot. If you like Evie and we have helped your Discord server somehow, please consider sponsoring us on GitHub Sponsors. The money we get from sponsorships helps us to keep the service running.
Thanks to all our sponsors:
Thanks goes to these wonderful people (emoji key):
tristan 💻 |
This project follows the all-contributors specification. Contributions of any kind welcome!