ver. 3.0.0
FCC-Bot is a discord bot used on the FCC Seoul Discord server. It is written in Go.
Its primary library is discordgo.
The instructions for this bot assume you already have a bot set up in the discord developer portal, and it is already invited to a server.
For development purposes, it is recommended to set up a new, private server that mirrors the structure of your production server.
If you are intending to fork FCCBot to use in your own server, understand that whilst FCCBot is built with some level of modularity in mind, it will require work to reshape it to fit your own needs.
- Clone the repository.
- Run
go getto install the packages needed.
You will need to create .env files before running the bot: dev.env and prod.env.
NOTE: Running the bot in dev or prod mode does not require the other .env file.
| env variable | how to obtain |
|---|---|
| BOT_TOKEN | The private key Discord gives you for a bot |
| BOT_ID | The bot's user id: right click the bot in the server |
| GUILD_ID | The guild's id: right click the server's name in discord |
| LOG_CHANNEL | The log channel's id: create a channel, and right click it |
| INTRO_CHANNEL | The introduction channel's id: create a channel, and right click it |
| LEARNING_RESOURCE_CHANNEL | The learning resource channel's id: create a channel, and right click it |
| RFR_POST | The post to listen for react-for-role reactions: create a post, and right click it |
| ROLE_VERIFIED | The role users receive when validated: create a role, and right click it |
| DB_PATH | The path of the database file: specify where to save the database file |
NOTE: We recommend the
DB_PATHpoint to./app/db/_store/{db_name}.sqlite. This path is already added to the .gitignore file.
| Command | use |
|---|---|
go run ./app/*.go |
Run the app using dev envs |
go run ./app/*.go -p |
Run the app using production envs |
go build -o fccbot ./app/*.go |
Build the app to a file named 'fccbot' |
make run |
Makefile command for running the app in dev mode |
make build |
Makefile command for building the app |
make deploy |
Makefile command to run the app as a process in PM2 |
make stop |
Makefile command to stop the app with PM2 |
NOTE: The above commands assume you are running the bot on Mac or Linux, and have PM2 installed globally. NOTE: go-sqlite3 package requires the environment variable CGO_ENABLED=1 and a gcc compiler present within your path.