TOLLIS (Toll Interoperability System)

This project (TOLLIS) provides a unified system for handling toll transactions across multiple stations and operators. Below is an overview of the project and its build instructions.

Overview

• Implements a toll interoperability solution where different toll stations can communicate with a central system to register and track transactions.
• Provides a back-end REST API, a CLI interface, and a web-based Portal for comprehensive access and management.
• Incorporates a database layer (MySQL >= 8.0) to store users, transactions, and payment data.

Main Components

1. REST API (back-end)

   • Handles requests for toll operations, user account management, and system admin tasks.
   • Built with Python (>= 3.10) using Flask.
   • Authentication was implemented to ensure security of payment data.

2. CLI Client

   • Offers command-line interaction (commands defined in “se2427.py”).
   • Supports querying and managing transaction data, user information, and more.

3. Web Portal

   • Runs on various web browsers with JavaScript enabled (Chrome,Firefox,Safari etc...)
   • Provides a graphical interface to the same functionality exposed by the API and CLI.

Prerequisites

• Python 3.10 or higher (installed and available in PATH).
• MySQL 8.0 or higher, running locally or accessible from the environment where you deploy.
• A modern web browser (Chrome, Firefox, Microsoft Edge, etc.) with JavaScript enabled.

Project Structure

• back-end/rest_api/
  Contains the REST API source code and database-related scripts (e.g., db_create.sql).

• cli-client/
  Contains the CLI program (se2427.py) and any related libraries.

• documentation/
  Includes project documentation such as the SRS (Software Requirements Specification).

Building and Deployment

Below are the instructions for building, deploying, and running TOLLIS:

1. Clone or download the repository.
   Example:

   git clone https://github.com/ntua-el21815/Software-Engineering-2024-25.git

2. Navigate to the project’s root directory (where the Makefile is located).

   cd Software-Engineering-2024-25

3. Choose the appropriate Makefile:

   • Windows: Use the default Makefile.
   • macOS / Linux: Rename “MakefileForMac” to “Makefile” (and remove or rename the default one).

4. Use one of the following build targets:

   • Complete Setup and Build (installs all dependencies, creates the database, generates certificates, etc.):

     make scratch

     This command is comprehensive but can be time-consuming. It also automatically creates the database.

   • Build Without Auto-Creating the Database:

     make

     If you prefer to manage the MySQL database setup yourself, run db_create.sql manually (found in back-end/rest_api/database) after this step.

5. Running the REST API:

   make run_api

   The API’s address (e.g., https://127.0.0.1:5000) will be displayed in the console.

6. Running the Web Portal:

   make run_portal

   The web address for the portal (e.g., https://127.0.0.1:8080) will also be displayed in the console.

CLI Usage

The CLI client (located in cli-client/) can run after you have installed all Python dependencies or after a successful make/make scratch:

cd cli-client
python ./se2427.py {commands}

Consult the CLI help (python ./se2427.py --help) for more details.

Further Information

Dummy Users (They work for the cli client and the web portal)

• ADMIN freepasses4all
• NAO default_password
• AM default_password
• EG default_password
• GE default_password
• KO default_password
• MO default_password
• NAO default_password
• NO default_password
• OO default_password

Refer to the accompanying SRS (SRS-softeng24-27.docx) in the “documentation” directory for a detailed functional and technical breakdown:

• Requirements
• Use cases
• Sequence diagrams
• Data models
• Non-functional requirements

This README is the starting point. The SRS document provides a deeper, comprehensive view of the system’s design and behavior.