https://github.com/josunlp/conventionbot
https://github.com/josunlp/conventionbot
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/josunlp/conventionbot
- Owner: JosunLP
- License: mit
- Created: 2023-12-09T17:07:50.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-17T14:55:19.000Z (about 2 years ago)
- Last Synced: 2025-03-20T10:11:50.910Z (about 1 year ago)
- Language: TypeScript
- Size: 105 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Conventionbot
This is the README file for the Conventionbot project.
The goal of this project is to create a Discord bot that can be used to manage the booking for the Convention Discord server.
## Requirements
To run Conventionbot, you will need the following:
- [Node.js](https://nodejs.org/en/) (v20.11.0 or higher)
- [npm](https://www.npmjs.com/) (v10.2.4 or higher)
- [Docker](https://www.docker.com/) (v25.0.2 or higher)
## Installation
To install Conventionbot, please follow these steps:
1. Clone the repository: `git clone https://github.com/your-username/Conventionbot.git`
2. Navigate to the project directory: `cd Conventionbot`
3. Install the dependencies: `npm install`
## Configuration
Conventionbot requires a `.env` file to store environment variables. Please create a `.env` file in the root directory of the project and populate it with the values, based on the `.env.template` file.
## Development
To run Conventionbot in development mode, please follow these steps:
1. Build the project: `npm run build`
2. Start the project: `npm run start`
The development server will start in your running Docker Instance. It will be accessible via the Test Discord server.
The deployed version of the bot will be accessible via the Convention Discord server.
## Contributing
If you would like to contribute to the project, please look at the [CONTRIBUTING.md](CONTRIBUTING.md) file for more information.
## Code of Conduct
Please read the [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) file for more information.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Authors
- [Jonas Pfalzgraf | ](https://github.com/josunlp)