shiori

A Fun and Wholesome Discord Bot!

shiori is a Discord bot that can bring fun to your server(s). Currently still in development.

Setting Up

If you want to try shiori, you need to run it by yourself since it's still not production-ready. You can run it by following the steps.

Prerequisites

1. Get a Discord bot token. You can get one in Discord Developers Page
2. Get a Fauna database. You can do it on their site and get the database token.

Deploy on Railway

Skip all the nonsense below. Railway is the fastest, easiest way to run shiori. Just click the button to get started.

Install with Docker

Make sure you have Docker and Docker Compose installed

1. Create a folder somewhere at your system and change to that folder. e.g.:

   mkdir shiori
   cd shiori

2. Create a docker-compose.yml and fill with the following content:

   version: "3.3"
   services:
     shiori:
       container_name: shiori
       image: ghcr.io/shiorilabs/shiori:latest
       env_file: ./.env

   Or, just download it from this repository's docker-compose.yml

3. Create an .env file and fill it with your Discord token and Fauna token. Examples are in this following file

4. Start it with Docker Compose

   docker-compose up -d

Install with Node

Make sure you have Node >=14.16.0 installed.

1. Clone this repository by running the following command:

   git clone https://github.com/ShioriLabs/shiori

2. Go to the cloned folder and install all the dependencies by running the following command:

   cd shiori
   npm install

3. Put your Discord token and FaunaDB token in .env.example and then remove the .example extension
4. Start it by running

   npm start

Inviting to Your Server(s)

1. Invite the bot by the link in the OAuth2 page of your Discord Developers application page (usually it's in https://discord.com/developers/applications/[your-bot-app-id]/oauth2)
2. Have fun!

License

MIT (See License)