Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
TheManWhoLikesToCode authored Jan 17, 2024
1 parent 8d265ed commit 91c1c28
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,20 @@

# Project Status
[![CodeQL](https://github.com/TheManWhoLikesToCode/Archive-Me/actions/workflows/codeql.yml/badge.svg)](https://github.com/TheManWhoLikesToCode/Archive-Me/actions/workflows/codeql.yml)
[![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 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.

![System Diagram](https://github.com/TheManWhoLikesToCode/Archive-Me/blob/main/System-Diagram.png)

## Features

- Automated login
Expand All @@ -18,6 +28,8 @@ Intended for Kettering University students: This tool is specifically designed f

## Usage/Demo

**Demo:** ![Archive Demo](https://github.com/TheManWhoLikesToCode/Archive-Me/blob/main/frontend/static/archive-demo.gif)

Try Archive-Me out [here!](https://archive-me.net)


Expand Down

0 comments on commit 91c1c28

Please sign in to comment.