Website • Support • Invite • Vote • ToS • Privacy
Would You bot provides activities and questions to keep your server active!
Getting Started
Starting the Development Environment
The development environment does not currently use Docker, so you will need to install the dependencies manually.
- Install Node.js (version 17.9.x or higher) and pnpm.
- Install all dependencies by running
pnpm installin the root directory. - Create a
.envfile in the root directory, copy the contents of.env.exampleinto.env, then fill in the values with your own values. - Run
pnpm run testto start the development environment. This will run all of the applications in development mode.
Formatting
Before committing, make sure to run pnpm format to format the code. This will also be run automatically when you commit, but it is better to run it manually to make sure you don't commit code that isn't formatted correctly.
Additionally, it is recommended to install the Prettier extension for VS Code. This will automatically format the code when you save (or based on the event you choose).
Committing
Follow the Angular commit message format. See here for more information.
NPM Scripts
You can run the below scripts with pnpm <script>.
| Script | Description |
|---|---|
start |
Runs the code in production mode |
dev |
Runs the code using nodemon in dev mode |
format |
Formats the code. |
Discord logs
Logs are also sent to Discord to allow for easier and more accessible debugging, as not everyone will have access to the host system, especially in production. The channels for the different log levels are defined in the .env file.
Project Details
Contributing
If you would like to contribute to the project, please read the contributing guidelines. If you have any questions, feel free to ask in the support server.
License
This project is licensed under the MIT License.