https://github.com/annsanns/distributeddiningphilosophers
https://github.com/annsanns/distributeddiningphilosophers
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/annsanns/distributeddiningphilosophers
- Owner: AnnsAnns
- License: eupl-1.2
- Created: 2024-11-02T11:04:01.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-04-08T02:10:24.000Z (about 2 months ago)
- Last Synced: 2025-04-14T22:52:29.306Z (about 1 month ago)
- Language: Rust
- Size: 5.54 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Distributed Dining Philosophers
## Overview
This repository contains the implementation of the Dining Philosophers problem for Distributed Systems using Rust and direct RPC calls. The project is structured into multiple components, each responsible for different parts of the system. The documentation for the project is provided in the `/docs` folder.
## Project Structure
- **cutlery/**: Contains the source code and configuration for the Cutlery component.
- **docs/**: Contains the documentation for the project, including the Requirements, Design, and Test Documentation (RDT).
- **frontend/**: Contains the frontend code and configuration.
- **shared_menu/**: Contains shared libraries used by different components.
- **waiter/**: Contains the source code and configuration for the Waiter component.
- **philosopher/**: Contains the source code and configuration for the Philosopher component.
- **.github/**: Contains GitHub Actions workflows for CI/CD.
## Building and Running the Project
The project itself was designed to run both natively and in Docker for easier development and deployment. The provided `Makefile` contains targets for building and running the project using Docker Compose. The project can also be built and run natively using the provided `native.sh` script.
To build and run the project, you can use the provided `Makefile`. The following targets are available:
- `all`: Builds and starts all components using Docker Compose.
- `start_waiter`: Builds and starts only the Waiter component.
- `start_philosopher`: Builds and starts only the Philosopher component.
- `clean`: Removes build artifacts and logs.
- `rebuild`: Rebuilds the Docker image.
- `compile_docs`: Compiles the LaTeX documentation.
Example command to start the entire system:
```sh
make up
```
# Continuous Integration
The repository uses GitHub Actions for CI/CD. The workflow defined in rdt.yml compiles the LaTeX documentation and uploads the resulting PDF file.
# Authors
Tom Hert - [email protected]
Laurin Zacharias - [email protected]
# License
This project is licensed under EUPLv1.2 see [HERE](./LICENSE). It may not be used without adhering to the license or explicit permission from the authors.
**This project is part of a university course. Unlicensed usage of this project to fulfill the course requirements is not allowed and would be considered plagiarism and not adhere to the license! We do not take any responsibility for the consequences of foolish actions and explicitly warn against it!**