This is the README for Rohan and Conor's Final Year Project

Frontend URL: https://conorpadraigmurphy.github.io/FYP/

Project Kanban + Gantt Chart

- Kanban: https://rohansikder4.atlassian.net/jira/software/projects/KAN/boards/1
- Gantt Chart: https://rohansikder4.atlassian.net/jira/software/projects/KAN/boards/1/timeline

Project Dependencies

1. Python: Download and install Python from the official Python website.

2. Node.js: Download and install Node.js from the official Node.js website.

3. Installs for app.py and video_processing.py

   • pip install ultralytics
   • pip install numpy
   • pip install opencv-python
   • pip install flask
   • pip install confluent-kafka
   • pip install pymongo
   • pip install python-dotenv
   • pip install flask-cors
   • Model: YoloV8 (Ultralytics)

4. Install Node packages (Run in Frontend folder)

   • npm install

How to run the application On a Mac/Linux Machine (Run each command in separate terminals)

1. Use Command where app.py is located (Run in video_processing folder)
   • flask run
2. Run video_consumer python script
   • python3 video_consumer.py
3. Run Frontend backend
   • node server.js
4. Run react frontend (Run command in frontend folder)
   • npm start

How to run the application on a Windows Machine (Run each command in separate terminals)

• Both the react frontend and express backend server are both hosted so there is no need to run those locally. All you will have to run are the Kafka, Flask and Python ML process which can be done using the following commands.

1. Start Zookeeper (Run within Kafka folder):
   .\bin\windows\zookeeper-server-start.bat .\config\zookeeper.properties

2. Start Kafka (Run within Kafka folder):
   .\bin\windows\kafka-server-start.bat .\config\server.properties

3. Check if kafka topics are listed (Run within Kafka folder):
   .\bin\windows\kafka-topics.bat --list --bootstrap-server localhost:9092

4. If there are no topics created, create them using the below commands (Run within Kafka folder):
   .\bin\windows\kafka-topics.bat --create --topic incoming-videos --bootstrap-server localhost:9092 --partitions 1 --replication-factor 1
   .\bin\windows\kafka-topics.bat --create --topic processed-videos --bootstrap-server localhost:9092 --partitions 1 --replication-factor 1

5. Run this command within the video_processing folder of the project directory:
   flask run

6. Run this command within the video_processing folder of the project directory:
   python video_consumer.py

7. Visit the Application and try out the features:
   https://conorpadraigmurphy.github.io/FYP/

Troubleshooting

If you encounter any errors or issues while setting up or running the application, please don't hesitate to contact us for assistance:

Email: G00389052@atu.ie

We'll be happy to help resolve any issues and ensure that you can successfully run the project.