README.md

Mote 2.0 (Meetbot Logs 2.0)

Mote (or Meetbot Logs) is a web service that aggregates and distributes summaries, minutes and logs of meetings that takes place in an IRC or Matrix channel for the Fedora Project.

Features

The web service has the following features

• Chronological lookup of meeting summaries, minutes and logs using an interactive calendar view
• Snappier loading up of content due to application-like interface and behaviour of the web service
• Channel-wise and date-wise distinction of meeting summaries, minutes and logs within modals
• Faster intuitive search of meeting summaries, minutes and logs using asynchronous fetching

Dependencies

Frontend

• Bootstrap 5
• Bootstrap Dark Mode
• Easy QR Code 4
• Font Awesome 5
• FullCalendar 5
• jQuery 3
• Socket.IO 4

Backend

• Beautiful Soup 4
• Fedora Messaging 3
• Flask 2
• Flask Caching 2
• Flask SocketIO 5
• Gevent 21
• Gunicorn 20
• Redis 4
• Requests 2

Development

• Black 21
• Flake8 3
• Isort 5
• Poetry
• Pytest 6
• Tox 3

Setup

Preliminary setup

1. Fork the repository.

   https://github.com/fedora-infra/mote
   

2. Clone the forked repository to your local storage.

   $ git clone [email protected]:<username>/mote.git
   

3. Navigate into the cloned repository.

   $ cd mote
   

4. Depending on the kind of approach required, follow either of the below sections.

Containerized setup

1. Install Podman on Fedora Linux.

   $ sudo dnf install podman
   

2. Download meeting logs in the directory of the cloned repository.

   • To download logs from a specific channel, append the channel name to the URL. For instance, for the "fedora-meeting" channel, use https://meetbot-raw.fedoraproject.org/fedora-meeting/.

   $ wget -r -P "./meetbot" -nH -R "index.html,robots.txt" -A ".html,.txt" https://meetbot-raw.fedoraproject.org/
   

3. Build the container image.

   $ podman build -t mote .
   

4. Start the development server on an IPv4 address and on port 9696.

   $ podman run -it --rm -p 9696:9696 -v ./meetbot:/srv/web/meetbot:Z -v ./mote:/opt/app/mote:Z mote
   

Native setup

1. Install Python 3, Virtualenv and Poetry on Fedora Linux.

   $ sudo dnf install python3 python3-virtualenv poetry
   

2. Download meeting logs in the /srv/web directory.

   • To download logs from a specific channel, append the channel name to the URL. For instance, for the "fedora-meeting" channel, use https://meetbot-raw.fedoraproject.org/fedora-meeting/.

   $ sudo mkdir -p /srv/web
   $ sudo chown $USER /srv/web
   $ wget -r -P "/srv/web/meetbot" -nH -R "index.html,robots.txt" -A ".html,.txt" https://meetbot-raw.fedoraproject.org/
   

3. Create and activate the virtual environment.

   $ virtualenv venv
   $ source venv/bin/activate
   

4. Install the defined packages from the Python project configuration file.

   $ (venv) poetry install
   

5. Start the development server on an IPv4 address and on port 9696.

   $ (venv) mote -p 9696 -4
   

Accessing

The project is be served on http://localhost:9696/ and with appropriate firewall rules, it should be accessible to the devices connected to the same network.

Contributing

Folks can contribute to the project by the following means

• Writing documentation to better explain the functionality and development of the web service
• Testing out the newly staged versions of the web service and reporting bugs on the issue tracker.
• Collaborating with the Fedora Websites and Apps Team to discuss about new features and advancements.
• Opening pull requests to the repository to address existing issues available on the issue tracker.