You need to clone the Suroi Git Submodule first, its used to import item definitions for some commands
You can do that by cloning the repo with the --recursive
flag or by running git submodule init && git submodule update
after cloning it.
This project utilizes pnpm. No other package manager is supported for this project.
To install dependencies for this project, open a command line interface at the directory of the cloned repository, and run:
pnpm install
This will create a node_modules
directory in that of your project and link the packages there.
Testing the application using a database on your own machine will require a localhost database setup:
- Copy the contents of
.env.example
to.env
in the root directory of the repository. - Replace the contents of each key with personalized values.
# Discord
DISCORD_TOKEN="<discord_application_token>"
DISCORD_ID="<discord_application_id>"
GUILD_ID="<guild_id>"
# Database
MONGO_URI="<uri>"
# Development mode?
NODE_ENV="production"
To run the bot locally in development, execute
pnpm run dev
To build for production, open up a terminal window in the root directory of the project and run
pnpm build
To execute a production build, run
pnpm start