https://github.com/TkTech/notifico
IRC Message Relay
https://github.com/TkTech/notifico
flask irc python
Last synced: about 1 month ago
JSON representation
IRC Message Relay
- Host: GitHub
- URL: https://github.com/TkTech/notifico
- Owner: TkTech
- License: mit
- Created: 2012-11-23T11:50:38.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2024-11-12T13:33:37.000Z (6 months ago)
- Last Synced: 2025-03-28T05:12:58.938Z (about 1 month ago)
- Topics: flask, irc, python
- Language: Python
- Homepage:
- Size: 2.27 MB
- Stars: 161
- Watchers: 12
- Forks: 39
- Open Issues: 33
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
- awesome-starred - TkTech/notifico - IRC Message Relay (python)
README
# Notifico!
Notifico is a small open-source ([MIT][]) replacement to the now-defunct
(since 2012) cia.vc service. It relays webhooks from common services to IRC
networks, such as GitHub, JIRA, Gitea, Jenkins, and Bitbucket.
Notifico is/has been used by [CPython][], [FreeBSD][], [Godot][],
[Qutebrowser][], [NASA][], and thousands of other projects.
## Development
### Getting Started
The easiest way to get started with the codebase is with docker:
```shell
git clone https://github.com/TkTech/notifico.git
cd notifico
docker-compose up
```
This will start redis, postgres, IRC bots, and the frontend on port 5000. If
you've never run Notifico before, also run:
```shell
docker-compose exec workers poetry run notifico tools bootstrap
```
This will populate the initial database. If you've run Notifico in the past,
instead use:
```shell
docker-compose exec workers poetry run alembic upgrade head
```
And finally if you need a user to log in with, create your initial admin
account with:
```shell
docker-compose exec workers poetry run notifico users create
docker-compose exec workers poetry run notifico users grant-role admin
```
## FAQ
### Why doesn't this project use X?
Odds are X (like React or Typescript) didn't exist a decade ago when this
project was created!
### Is this project still maintained?
Yes! The project is currently going through modernization. It has remained
largely unchanged for the last 8-9 years, as IRC and the services feeding into
it are largely stable and unchanging themselves.
[MIT]: http://en.wikipedia.org/wiki/MIT_License
[cpython]: github.com/python/cpython
[FreeBSD]: https://www.freebsd.org/
[godot]: https://godotengine.org/
[qutebrowser]: https://www.qutebrowser.org/
[NASA]: https://nasa.gov