Skip to content

README.md

Latest commit

 

History

History
54 lines (38 loc) · 1.48 KB

README.md

File metadata and controls

54 lines (38 loc) · 1.48 KB
Raw

Project Name: Apology Machine

Description

Apology Machine is a playful and innovative project developed for the "Terrible Ideas Hackathon". It uses a Raspberry Pi and wireless security techniques to hijack WiFi networks and broadcast humorous apologies. This project is intended for educational and entertainment purposes only.

Features

  • Raspberry Pi-based WiFi hijacking
  • Automated apology message broadcasting
  • Customizable apology messages
  • Secure and controlled network access

Installation

Prerequisites

  • Raspberry Pi (Model 3B+ or newer recommended)
  • WiFi module (compatible with Raspberry Pi)
  • Basic knowledge of Linux and Python

Setup

  1. Clone the repository: 
    git clone https://github.com/wu-changxing/ApologyMachine.git
  2. Navigate to the project directory: 
    cd ApologyMachine/backend
  3. Install the required dependencies: 
    pip install -r requirements.txt
uvicorn app.main:app --reload

Usage

Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact