The aim of this project is to demonstrate the capabilities of the Sodacore framework, and in an attempt to provide an example of the core features of the framework, including plugins.
Please note, this project is absolutely nonsensical and is purely for demonstration purposes.
To get started, follow the steps below.
Some pre-requisites are required are expected:
- You have installed Bun.
- You have created a Discord Bot.
- You have a Discord bot token, client ID, and guild ID.
The guild ID is technically optional, but when it comes to registering slash commands with Discord, registering them globally can take up to an hour to propagate, so it is recommended to register your commands to a specific guild as it's almost instantaneous.
To get started;
- Clone the repository to a location of your choice.
git clone git@github.com:sodacore/demo.git ~/sodacore-demo- Navigate to the project directory.
cd ~/sodacore-demo- Install the dependencies,
bun install- Setup your environment variables.
cp env.template .envThen insert your variables into the
.envfile.
- Start the project.
bun devTo build the project, you can run:
bun run buildAnd then you can run the project with:
bun startRead our documentation to learn more about the framework and how to create your own projects using it.