https://github.com/semaphore-protocol/discord-bot
A Discord bot for Semaphore.
https://github.com/semaphore-protocol/discord-bot
Last synced: 13 days ago
JSON representation
A Discord bot for Semaphore.
- Host: GitHub
- URL: https://github.com/semaphore-protocol/discord-bot
- Owner: semaphore-protocol
- License: mit
- Created: 2023-04-04T18:05:32.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-22T12:14:25.000Z (over 1 year ago)
- Last Synced: 2025-01-10T14:30:59.799Z (6 months ago)
- Language: JavaScript
- Homepage: https://discord.com/api/oauth2/authorize?client_id=1082429985496772628&permissions=1024&scope=bot
- Size: 39.1 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Semaphore Discord Bot
## 🛠 Install
Clone this repository:
```bash
git clone https://github.com/semaphore-protocol/discord-bot.git
```
And install the dependencies:
```bash
cd discord-bot && yarn
```
## 📜 Usage
Copy the `.env.example` file as `.env`:
```bash
cp .env.example .env
```
Add your environment variables and run:
```bash
yarn start
```
### Code quality and formatting
Run [ESLint](https://eslint.org/) to analyze the code and catch bugs:
```bash
yarn lint
```
Run [Prettier](https://prettier.io/) to check formatting rules:
```bash
yarn prettier
```
Or to automatically format the code:
```bash
yarn prettier:write
```
### Conventional commits
Semaphore uses [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/). A [command line utility](https://github.com/commitizen/cz-cli) to commit using the correct syntax can be used by running:
```bash
yarn commit
```
It will also automatically check that the modified files comply with ESLint and Prettier rules.