{"id":19676055,"url":"https://github.com/wannacry081/packagepal","last_synced_at":"2026-04-10T07:03:39.134Z","repository":{"id":210090682,"uuid":"725682137","full_name":"WannaCry081/PackagePal","owner":"WannaCry081","description":"PackagePal is an embedded system project using Flutter and Firebase for the Mobile Application, and C++ for programming the ESP32 Microcontroller. Moreover, this project is a smart container dual-layered package receiver that uses a keypad, monitor, sim module, etc. to incorporate a secure container for your parcels to be received.","archived":false,"fork":false,"pushed_at":"2024-02-26T14:49:32.000Z","size":10816,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-10T04:28:29.397Z","etag":null,"topics":["cpp","dart","esp32","firebase","flutter","platformio"],"latest_commit_sha":null,"homepage":"","language":"Dart","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/WannaCry081.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2023-11-30T16:48:37.000Z","updated_at":"2023-12-22T16:37:15.000Z","dependencies_parsed_at":"2024-11-11T17:42:22.779Z","dependency_job_id":null,"html_url":"https://github.com/WannaCry081/PackagePal","commit_stats":null,"previous_names":["wannacry081/packagepal"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WannaCry081%2FPackagePal","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WannaCry081%2FPackagePal/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WannaCry081%2FPackagePal/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WannaCry081%2FPackagePal/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/WannaCry081","download_url":"https://codeload.github.com/WannaCry081/PackagePal/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240985590,"owners_count":19889114,"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":["cpp","dart","esp32","firebase","flutter","platformio"],"created_at":"2024-11-11T17:26:56.859Z","updated_at":"2026-04-10T07:03:39.067Z","avatar_url":"https://github.com/WannaCry081.png","language":"Dart","funding_links":[],"categories":[],"sub_categories":[],"readme":"# PackagePal\n\n## Project Overview\n\nThis repository contains the code and documentation for an embedded project that leverages the ESP32 microcontroller for its Bluetooth and Wi-Fi capabilities. The project also includes a sleek and lightweight mobile application developed in Flutter and utilizes Firebase for real-time data management and authentication.\n\n## Table of Contents\n\n- [Project Overview](#project-overview)\n- [Getting Started](#getting-started)\n  - [Prerequisites](#prerequisites)\n  - [Installation](#installation)\n- [Directory Structure](#directory-structure)\n- [Backend (PlatformIO)](#backend-platformio)\n- [Frontend (Flutter)](#frontend-flutter)\n- [Firebase Integration](#firebase-integration)\n- [Usage](#usage)\n- [Contributing](#contributing)\n- [License](#license)\n\n## Getting Started\n\n### Prerequisites\n\nBefore you begin, ensure you have met the following requirements:\n\n- [PlatformIO](https://platformio.org/) is installed for the backend development.\n- [Flutter](https://flutter.dev/) is installed for the frontend development.\n- Firebase account for integrating Firebase services into the project.\n\n### Installation\n\n1. Clone this repository:\n\n   ```bash\n   git clone https://github.com/shielamae02/PackagePal.git\n   ```\n\n2. Set up the backend using PlatformIO:\n   - Open the `backend` directory in your preferred code editor.\n   - Install the required dependencies using PlatformIO.\n   - Configure the ESP32 microcontroller with your Wi-Fi and Bluetooth settings.\n\n3. Set up the frontend using Flutter:\n   - Open the `frontend` directory in your preferred code editor.\n   - Run the following command to get the Flutter dependencies:\n\n   ```bash\n   flutter pub get\n   ```\n\n4. Configure Firebase integration:\n   - Create a Firebase project on the [Firebase Console](https://console.firebase.google.com/).\n   - Configure your Firebase project settings in the Flutter app by following the Firebase setup documentation.\n\n## Directory Structure\n\nThe project structure is organized as follows:\n\n- `/backend`: Contains the PlatformIO code for the ESP32 microcontroller.\n- `/frontend`: Contains the Flutter mobile application code.\n- `/docs`: Documentation and resources related to the project.\n\n## Backend (PlatformIO)\n\nThe backend of this project is based on PlatformIO, which allows you to develop and deploy code to the ESP32 microcontroller. It handles Bluetooth and Wi-Fi capabilities, along with other embedded functionalities. Ensure you configure the `platformio.ini` file with the necessary settings for your ESP32.\n\n## Frontend (Flutter)\n\nThe frontend of this project is developed using Flutter, a UI toolkit for building natively compiled applications for mobile, web, and desktop from a single codebase. You can customize and extend the Flutter app to meet your specific requirements.\n\n## Firebase Integration\n\nFirebase is used for real-time data management and authentication in the project. Follow Firebase's documentation to set up Firebase services, including Firestore for real-time data storage and Firebase Authentication for user management. Configure your Firebase project settings in the Flutter app.\n\n## Usage\n\n1. Start the PlatformIO backend by uploading the code to your ESP32 microcontroller.\n2. Run the Flutter app on your mobile device or emulator by executing:\n\n   ```bash\n   flutter run\n   ```\n\n3. Use the mobile app to interact with the embedded system, manage real-time data, and authenticate users.\n\n## Contributing\n\nContributions are welcome! If you'd like to contribute to this project, please follow these steps:\n\n1. Fork the repository.\n2. Create a new branch for your feature or bug fix.\n3. Make your changes and commit them with clear commit messages.\n4. Push your branch to your forked repository.\n5. Create a pull request with a detailed description of your changes.\n\n## License\n\nThis project is licensed under the [MIT License](LICENSE). Feel free to use and modify the code as needed for your own projects.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwannacry081%2Fpackagepal","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwannacry081%2Fpackagepal","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwannacry081%2Fpackagepal/lists"}