{"id":23123485,"url":"https://github.com/devvyyxyz/the-maze-project","last_synced_at":"2025-07-20T12:05:50.718Z","repository":{"id":267486710,"uuid":"869607162","full_name":"devvyyxyz/The-maze-project","owner":"devvyyxyz","description":"Virus and anti-virus race to computer in the centre of the maze.","archived":false,"fork":false,"pushed_at":"2025-02-25T15:46:02.000Z","size":47015,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-04T04:27:32.746Z","etag":null,"topics":["group-project","maze","open-source","project","python","science"],"latest_commit_sha":null,"homepage":"https://devvyyxyz.github.io/The-maze-project/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/devvyyxyz.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-10-08T15:22:58.000Z","updated_at":"2025-02-25T15:45:41.000Z","dependencies_parsed_at":null,"dependency_job_id":"514d10a6-d13d-46b9-86d0-c6aadabd3255","html_url":"https://github.com/devvyyxyz/The-maze-project","commit_stats":null,"previous_names":["devvyyxyz/the-maze-project"],"tags_count":30,"template":false,"template_full_name":null,"purl":"pkg:github/devvyyxyz/The-maze-project","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devvyyxyz%2FThe-maze-project","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devvyyxyz%2FThe-maze-project/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devvyyxyz%2FThe-maze-project/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devvyyxyz%2FThe-maze-project/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/devvyyxyz","download_url":"https://codeload.github.com/devvyyxyz/The-maze-project/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devvyyxyz%2FThe-maze-project/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266120299,"owners_count":23879290,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["group-project","maze","open-source","project","python","science"],"created_at":"2024-12-17T07:34:55.049Z","updated_at":"2025-07-20T12:05:50.688Z","avatar_url":"https://github.com/devvyyxyz.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# The-maze-project\nVirus and anti-virus race to computer in the centre of the maze.\n\n# Project tree\n```\nthe-maze-project/\n├── README.md\n├── LICENSE\n├── requirements.txt\n├── setup.py\n├── .gitignore\n├── src/\n│   ├── __init__.py\n│   ├── main.py\n│   ├── config/\n│   │   ├── __init__.py\n│   │   ├── settings.py\n│   ├── controllers/\n│   │   ├── __init__.py\n│   │   ├── character_controller.py\n│   │   ├── sensor_controller.py\n│   ├── models/\n│   │   ├── __init__.py\n│   │   ├── character.py\n│   │   ├── maze.py\n│   ├── sensors/\n│   │   ├── __init__.py\n│   │   ├── ultrasonic_sensor.py\n│   │   ├── infrared_sensor.py\n│   ├── utils/\n│   │   ├── __init__.py\n│   │   ├── logger.py\n│   │   ├── helper_functions.py\n│   └── views/\n│       ├── __init__.py\n│       ├── maze_view.py\n│       ├── character_view.py\n├── tests/\n│   ├── __init__.py\n│   ├── test_character.py\n│   ├── test_maze.py\n│   ├── test_sensors.py\n│   ├── test_controllers.py\n│   ├── test_utils.py\n└── docs/\n    ├── index.md\n    ├── installation.md\n    ├── usage.md\n    ├── api_reference.md\n```\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n# Installation Guide\nThis guide will help you set up and run the project on your Raspberry Pi 4.\n\n## Prerequisites\n1. Raspberry Pi 4 with Raspbian OS installed.\n2. Python 3.7+ installed on your Raspberry Pi.\n3. Git installed on your Raspberry Pi.\n\n## Step-by-Step Installation\n1. Clone the Repository\n\n    Open a terminal and run the following command to clone the repository:\n```\ngit clone https://github.com/yourusername/the-maze-project.git\ncd the-maze-project\n```\n\n2. Create a Virtual Environment\n\n    It's a good practice to use a virtual environment to manage dependencies. Run the following commands:\n```\npython3 -m venv venv\nsource venv/bin/activate\n```\n\n\n3. Install Dependencies\n\n    Install the required Python packages using pip:\n```\npip install -r requirements.txt\n```\n\n4. Set Up Configuration\n\n    Configure the settings as needed. Open settings.py and modify the configuration parameters according to your setup.\n\n5. Connect Sensors\n\n    Connect the sensors (ultrasonic, infrared, etc.) to the appropriate GPIO pins on your Raspberry Pi. Refer to the sensor documentation for wiring instructions.\n\n6. Run the Application\n\n    Navigate to the `src` directory and run the main application:\n```\ncd src\npython main.py\n```\n\n## Additional Information\n- Updating the Project\nTo update the project with the latest changes, navigate to the project directory and pull the latest changes:\n```\ngit pull origin main\n```\n\n- Deactivating the Virtual Environment\nWhen you're done working on the project, you can deactivate the virtual environment by running:\n```\ndeactivate\n```\n\n## Troubleshooting\n- Dependency Issues\nIf you encounter issues with dependencies, try reinstalling them:\n```\npip install --force-reinstall -r requirements.txt\n```\n\n- Sensor Connection Issues\nEnsure that the sensors are properly connected to the GPIO pins and that the correct pins are specified in the configuration file.\n\n*For further assistance, refer to the documentation or contact the project maintainers.*\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n# Contributing\nWe welcome contributions to this project! If you would like to contribute, please follow these steps:\n\n1. Fork the Repository\n\n    Fork the repository to your own GitHub account by clicking the \"Fork\" button at the top right of the repository page.\n\n2. Clone the Forked Repository\n\n    Clone the forked repository to your local machine:\n```\ngit clone https://github.com/yourusername/the-maze-project.git\ncd the-maze-project\n```\n\n3. Create a Branch\n\n    Create a new branch for your feature or bug fix:\n```\ngit checkout -b feature-or-bugfix-name\n```\n\n4. Make Your Changes\n\n    Make your changes to the codebase. Ensure that your code follows the project's coding standards and passes all tests.\n\n5. Install Dependencies\n\n    If you haven't already, create a virtual environment and install the dependencies:\n```\npython3 -m venv venv\nsource venv/bin/activate\npip install -r requirements.txt\n```\n\n6. Run Tests\n\n    Run the tests to ensure that your changes do not break existing functionality:\n```\npython -m unittest discover tests\n```\n\n7. Commit Your Changes\n\n    Commit your changes with a descriptive commit message:\n```\ngit add .\ngit commit -m \"Description of your changes\"\n```\n\n8. Push to Your Fork\n\n    Push your changes to your forked repository:\n```\ngit push origin feature-or-bugfix-name\n```\n\n9. Create a Pull Request\n\n    Go to the original repository on GitHub and create a pull request from your forked repository. Provide a clear description of your changes and any relevant information.\n\n10. Review Process\n\n    Your pull request will be reviewed by the project maintainers. They may request changes or provide feedback. Once your pull request is approved, it will be merged into the main branch.\n\n## Code of Conduct\nPlease note that this project adheres to a Code of Conduct. By participating, you are expected to uphold this code.\n\n***Thank you for contributing!**","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevvyyxyz%2Fthe-maze-project","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdevvyyxyz%2Fthe-maze-project","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevvyyxyz%2Fthe-maze-project/lists"}