From 9706c528771ab7c0259a93ca3e64bfa3e4073421 Mon Sep 17 00:00:00 2001 From: Jay Date: Wed, 17 Jan 2024 13:43:42 -0500 Subject: [PATCH] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 76e690a..22b62a9 100644 --- a/README.md +++ b/README.md @@ -3,15 +3,15 @@ [![Docker Image CI](https://github.com/TheManWhoLikesToCode/Archive-Me/actions/workflows/docker-image.yml/badge.svg)](https://github.com/TheManWhoLikesToCode/Archive-Me/actions/workflows/docker-image.yml) [![Run Behave Tests](https://github.com/TheManWhoLikesToCode/Archive-Me/actions/workflows/BDD-Tests.yml/badge.svg)](https://github.com/TheManWhoLikesToCode/Archive-Me/actions/workflows/BDD-Tests.yml) [![Run Blackboard Session Tests](https://github.com/TheManWhoLikesToCode/Archive-Me/actions/workflows/Unit-Tests.yml/badge.svg)](https://github.com/TheManWhoLikesToCode/Archive-Me/actions/workflows/Unit-Tests.yml) -# Archive-Me +# Archive-Me Archive Me is a tool for students to easily archive and track their course materials on Blackboard. It helps students store and organize their coursework for long-term access and reference. This tool is useful for college students to preserve their academic records. This platform is specifically designed for Kettering University students to extract their course information from Blackboard. It uses session requests and Python to automate the login process and extract the necessary data. Please note that this tool is only intended for use by Kettering University students. I apologize for any inconvenience this may cause to users from other institutions. ## Background -Archive-Me is a project I developed in between work and school rotations to work on my full-stack application development. This project is hosted on a Raspberry Pi 4 using a combination of Github Actions, Watchtower, and Portainer. I automated the build and deployment of updates based on PRs and updates to Main. Below is a system diagram. +I developed Archive-Me, a full-stack application project, during my breaks from work and school. It's hosted on a Raspberry Pi 4 and utilizes Github Actions, Watchtower, and Portainer for seamless integration. The system automates build and deployment processes in response to PRs and main branch updates. The application uses NGINX as a reverse proxy to manage incoming traffic and expose specific ports. It routes requests to the uWSGI server, which communicates with the Flask application via WebSocket. A system diagram is provided for detailed architecture. ![System Diagram](https://github.com/TheManWhoLikesToCode/Archive-Me/blob/main/System-Diagram.png)