CS361: Course Project — Reading Tracker

Because you've already forgotten what you've read!

Table of Contents

• CS361: Course Project — Reading Tracker
  • Table of Contents
  • About
  • Getting Started
    • Prerequisites
  • Installation
    • Build and run the program
  • TODO
  • Built With
  • License

About

This full-term project uses a microservices architecture to track reading completed by the user. The project is developed using agile methodologies. The user interface adheres to the 8 Cognitive Style Hueristics (CSH). Data persistence is provided using Python's built-in SQLite3 library. Microservices for this project are provided by @jay2002shah.

Getting Started

These instructions will get you a copy of the project up and running on your local machine.

Prerequisites

You need to have a machine with Python 3.10.x installed.

$ python --version
Python 3.10

Installation

All installation is handled using pip or pipenv. The following steps will install the project dependencies.

Build and run the program

# Terminal 1
$ git clone https://github.com/4N0NYM0U5MY7H/CS361_Course_Project
$ cd CS361_Course_Project
$ pipenv install
$ cd microservice
$ pipenv run microservice.py

# Terminal 2
$ cd CS361_Course_Poject/app
$ python main.py

TODO

Refer to the Project Roadmap, Milestones, and Issues for the current task list.

Built With

• 
• 

License

This project is licensed under the MIT License - see the LICENSE file for details.