This is a multi-purpose Discord bot written in Typescript.
Libraries: discord.js-light
Databases: MySQL
Other: Docker
Building is done with docker-compose build.
Running is done with docker-compose up.
Shutting down is with docker-compose down.
- Copy
.docker/extra/root.jsonintoconfigs/root.jsonand modify it- Import the database schema from
.docker/extra/schema.sql- And most importantly don't expose the MySQL port in production
| Command | Description |
|---|---|
yarn build |
Builds a production version. |
yarn dev |
Builds and hosts a developer version. |
yarn serve |
Hosts the production version, if built. |
yarn pretty |
Formats the codebase using Prettify. |
yarn lint |
Runs ESlint linter on the codebase. |
yarn linty |
Automatically lints the codebase using ESlint. |
yarn typecheck |
Runs Typescript checker on the codebase. |
If you want a feature added or you found a bug, make a new Issue.
If you want to contribute, make a new Pull Request.
There are no guidelines or any of the sort and contributing is highly encougaraged!
Nekomaid is licensed under the GNU General Public License v3.0.