- Clone this repository
git clone https://github.com/iigorkowalczyk/majo.exe.git - Go to
/packages/database/directory and follow Database Setup tutorial - Grab a Discord Bot token and client secret on Discord's developer portal Tutorial
- Add redirect URL to Discord's developer portal (https://your-website.com/api/auth/callback/discord)
- Create new file or edit existing
.envfile in root directory of the project - In
.envfile set this values:TOKEN- Discord bot token [Tutorial]SECRET- Random string (min. length = 32 chars)CLIENT_SECRET- Discord bot secret [Tutorial]NEXTAUTH_URL- Your website URL (with protocol)NEXT_PUBLIC_URL- Your website URL (with protocol)HOTJAR_ID- Your Hotjar ID (optional)- Database URLs [Tutorial]
DATABASE_URL- Main database URLDATABASE_URL_UNPOOLED- Direct database URL (optional)
- Run
pnpm ito install all dependencies - Go to
/packages/config/directory and change values in/configs/dashboard.jsto your values - Go back to main directory and run
pnpm run dev --filter=dashboardorpnpm run deploy --filter=dashboardto start dashboard - That's it! You can now visit your dashboard for the first time!
- Click
Deploy with Vercelbutton above and follow instructions - Go to
/packages/database/directory and follow Database Setup tutorial - Grab a Discord Bot token and client secret on Discord's developer portal Tutorial
- Add redirect URL to Discord's developer portal (https://your-project.vercel.app/api/auth/callback/discord)
- In your forked repository go to /packages/config/ directory and change values in /configs/dashboard.js to your values
- Import this repository to Vercel (click button above)
- Set environment variables from your root
.envfile in Vercel dashboard - Set Root Directory in Vercel dashboard to
/apps/dashboard/(Also include files from outside the root directory) - Click
Deploybutton - That's it! You can now visit your dashboard for the first time!
Note
Your Deploy URL for Vercel will be https://project-name.vercel.app/, but you can add your own domain in Vercel dashboard. Don't forget to add it to Discord's developer portal.
TOKEN=DISCORD_BOT_TOKEN
SECRET=SECRET_STRING
CLIENT_SECRET=DISCORD_BOT_SECRET
NEXTAUTH_URL=YOUR_WEBSITE_URL
NEXT_PUBLIC_URL=YOUR_WEBSITE_URL
# ... Database credentials
Warning
This file should be in root directory of the project. This file is super secret, better to not share it!
Ensure your setup meets these prerequisites before setting up Majo.exe:
PostgreSQL 14xor higherNode.js 18xor higher(Any)Linux x64¹~512MBof RAM (minimum)~3GBof hard drive space (minimum)
Note
- Debian based distros are recommended, Dashboard can also run on Windows and MacOS but it's not recommended.
- @binary-blazer - Hosting support
- @r-kjha - Emoji config support, Bug fixes, New features, Testing
- @Joao-Victor-Liporini - Bug fixes, Command handler improvements, Testing, New features
- @evandev - Bug fixes, Testing
- @krzesl0 - New Features, Bug fixes, Testing
- @_index1337 - Readme tutorials
- @Wafelowski - Translation improvements
- @Sakshyam6966 - New Features, Bug fixes, Testing
These wonderful people and services have helped develop Majo.exe, without them this project would not exist. Thanks goes to these wonderful people!
| Sponsor | Description | |
|---|---|---|
 |
TrestHost | TrestHost is a good and powerful hosting provider providing servers from the USA and Germany. Try us out today! |
If you have any issues with the bot please create new issue here. When creating new issue please provide as much information as possible. If you can, please provide logs from console.
When submitting a pull request:
- Clone the repo.
- Create a branch off of
masterand give it a meaningful name (e.g.my-awesome-new-feature). - Open a pull request on GitHub and describe the feature or fix.
We will review your pull request as soon as possible. We might suggest some changes or improvements.
This project is licensed under the MIT. See the LICENSE file for details