Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/southclaws/cj

CJ is a Discord bot that hangs around in the open.mp/burgershot.gg community discord.
https://github.com/southclaws/cj

discord discord-bot discordgo golang-application

Last synced: 15 days ago
JSON representation

CJ is a Discord bot that hangs around in the open.mp/burgershot.gg community discord.

Host: GitHub
URL: https://github.com/southclaws/cj
Owner: Southclaws
License: gpl-3.0
Created: 2017-02-22T09:09:45.000Z (almost 8 years ago)
Default Branch: master
Last Pushed: 2024-06-05T10:30:01.000Z (7 months ago)
Last Synced: 2024-06-18T22:59:43.154Z (6 months ago)
Topics: discord, discord-bot, discordgo, golang-application
Language: Go
Homepage:
Size: 6.7 MB
Stars: 41
Watchers: 11
Forks: 31
Open Issues: 21
Metadata Files:
- Readme: readme.md
- License: LICENSE

Awesome Lists containing this project

README

# SA:MP/open.mp Discord Bot

[![All Contributors](https://img.shields.io/badge/all_contributors-14-orange.svg?style=flat-square)](#contributors)

![CJ](cj.png)

## Development

This project is open to anyone who wants to contribute, large or small! Whether you noticed a typo or want to add a
whole new feature, go for it!

Large additions should be discussed in issues or on Discord first. If you're new to Golang, ask me on Discord for where
to start and you can use CJ as a starting point for a contribution.

### Testing/Workflow

To run the app, you need:

- A Discord server to test - you can't use the SA:MP Discord to do tests
- Go 1.11 - no guarantees on older versions
- A Discord bot with the 'Server Members Intent' enabled

If you don't own/admin a Discord server, creating one is simple, you can do it from the same menu you join discord
servers from.

#### Running with a database

If you want to develop features that require persisting data, spin up a MongoDB database. If you have Docker installed,
this is as simple as running `make mongodb` which will start a MongoDB container with a user `root` that has no
password. If you don't have Docker, you'll need to
[install MongoDB onto your system.](https://docs.mongodb.com/manual/installation/).

#### Running without a database

If you don't need a database for your feature, just add `NO_DATABASE=true` to `.env`.

Finally, the application requires some configuration. Copy the `example.env` to `.env` and modify it to use your token
and various IDs. Depending on what you're working on, some values won't be necessary.

Now you can build and run the application with `make local`.

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

_{Octavian Dima}
💻 🤔 🐛
_J0shES
💻 🤔 🐛 🚧
_Dayvison
💻
_{Adrian Graber}
💻
_{__SyS__}
💻
_Robster
🖋
_{Lasha Kanteladze}
💻 ⚠️ 🤔
_{Kristo Isberg}
💻 ⚠️ 🤔
_{Marcel Schramm}
💻
_Codeah
💻
_{Giampaolo Falqui}
📖
_Sunehildeep
💻
_TommyB
🖋
_{Nikola Yanakiev}
🖋