https://github.com/chatsift/ama
Helping sift through questions and provide answers to the community
https://github.com/chatsift/ama
ama bot discord hacktoberfest
Last synced: 5 months ago
JSON representation
Helping sift through questions and provide answers to the community
- Host: GitHub
- URL: https://github.com/chatsift/ama
- Owner: ChatSift
- License: other
- Created: 2021-03-03T07:01:13.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-08-16T20:21:49.000Z (almost 2 years ago)
- Last Synced: 2024-08-16T21:30:47.681Z (almost 2 years ago)
- Topics: ama, bot, discord, hacktoberfest
- Language: TypeScript
- Homepage: https://automoderator.app/ama/
- Size: 2.48 MB
- Stars: 14
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# AMA
## About
You can read all about the bot [here](todo).
## Self hosting
This repository contains source code for the bot itself under [packages/bot](./packages/bot/).
A Docker image that can be used for running anything in this monorepo is available on DockerHub under `chatsift/ama`.
---
With all those notices out of the way, the [docker-compose.yml](./docker-compose.yml) file
is probably the easiest way to get started.
Before you do anything else (even if you're using Docker), make sure to run `yarn --immutable`.
If you don't have yarn installed, `npm i -g yarn` (assuming you have a nodejs installation).
Simply create a new file called `.env`, follow the example from [.env.example](./.env.example),
and then `docker-compose build && docker-compose up -d`.
Now that the bot and postgres server are up, run `yarn deploy-commands` to register
the global slash commands, and then `yarn prisma migrate deploy` to get the database ready.
Alternatively, you can run your own postgresql instance, build the code with `yarn build`,
and start up the bot using `yarn start-bot`
in whatever way keeps it online (e.g. pm2).
---
## Updating a self-hosted instance
Assuming you're using Docker, you essentially just need to follow the steps above again.
`docker-compose build && docker-compose up -d`, re-deploy slash commands, and deploy prisma
migrations.
## Contributing/working on the project
Just about everything above, except set the `NODE_ENV` env var to `dev`. If you're trying to
figure out something wrong with cron jobs, `DEBUG_JOBS=true`.
## Licensing
This project is lincensed under the GNU AGPLv3 license. View the full file [here](./LICENSE).