Akane

Applications

For more information about some of the apps, see their README files.

@akane/client

The client is a powerful Discord bot built using Discord.js. It also has a localization system built-in using typesafe-i18n and a command handler using discordx.

@akane/web

The web application is a Next.js application that is used to interact with the Discord API. It is written in TypeScript and uses SWR for data fetching and Tailwind CSS for styling.

Packages

@akane/database

This package contains a Prisma schema and client for the database that can be shared between all applications.

@akane/tsconfig

This package contains some common TypeScript configurations files (tsconfig.json).

How to use

# Clone the repository
git clone git@github.com:akanehq/akane.git

# Install dependencies
pnpm install

# Build the packages
pnpm build

Docker Support

This bot is also configured to run in a Docker container using Docker Compose. To run the bot in a container, fill all the .env files with the correct values and run the following command:

docker-compose up -d

Environment Variables

Environment Variable	Required
APP_SCOPE	When using docker-compose
POSTGRES_DB	Yes
POSTGRES_USER	Yes
POSTGRES_PASSWORD	Yes