Giter Site home page Giter Site logo

thorn's Introduction

Thorn

A Minecraft moderation panel for server owners.

Preparing LiteBans

Thorn requires an SQL database to function, so if you already have one set up, you can skip to the next section.

  1. Obtaining an SQL database is quite simple. With the help of Planetscale, you can create an account and get a free database with 5 gigabytes of storage.
  2. Now, put the connection information into plugins/LiteBans/config.yml then change the driver to MySQL, and you're done ๐ŸŽ‰

First time setup

We recommend creating a fork of Thorn, rather than cloning, as it saves the time of creating your own repository. (It also lets you update Thorn very quickly)

# Clone your fork
git clone https://github.com/[your username]/Thorn
# Go to the project directory
cd Thorn
# Install dependencies
npm install

After all that, copy .env.example into .env, and fill it accordingly. Then, migrate your database using:

npx prisma db push

After that, if you want to use the Discord bot, do:

npm run register

This will register the bot commands for your bot.

Deployment

To deploy your very own Thorn instance, head over to Vercel and select your fork, then fill in your enviroment variables. (tip: you can paste in your .env directly)

Note: Change the value of NEXT_AUTH_URL to [your Vercel URL], or else things will not work properly

To setup the Discord bot, take your Vercel URL and come over to the Discord Developers portal. In the "Interaction Webhook URL" section, enter the following: <your Vercel URL>/api/bot, and boom!

Tech Stack

Thorn runs solely on Next.js with the T3 stack, bootstrapped with Create T3 App.

Here are some highlights:

  • tRPC
  • NextAuth.js
  • Prisma
  • Mantine

License

Thorn uses the MPL-2.0 license.

thorn's People

Contributors

gstudiosx2 avatar prettyflowerss avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

thorn's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.