{"id":21864168,"url":"https://github.com/cellie0320/arwss","last_synced_at":"2025-10-07T19:11:06.276Z","repository":{"id":264351773,"uuid":"883315410","full_name":"Cellie0320/ARWSS","owner":"Cellie0320","description":"ARWSS is an Automated Robotic Waste Sorting System using CoppeliaSim, Lua scripts, and a KR16 robot arm with vision sensors and a conveyor belt. The Python backend handles logic, database interactions, and APIs, while the React frontend provides real-time dashboards with barcharts and simulation recordings.","archived":false,"fork":false,"pushed_at":"2025-02-03T20:42:04.000Z","size":65375,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-03T21:33:04.703Z","etag":null,"topics":["coppeliasim","css","javascript","lua","python","react"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Cellie0320.png","metadata":{"files":{"readme":"README.md","changelog":null,"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-11-04T18:46:48.000Z","updated_at":"2025-02-03T20:42:08.000Z","dependencies_parsed_at":"2025-01-26T15:37:29.707Z","dependency_job_id":null,"html_url":"https://github.com/Cellie0320/ARWSS","commit_stats":null,"previous_names":["cellie0320/arwss"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cellie0320%2FARWSS","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cellie0320%2FARWSS/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cellie0320%2FARWSS/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cellie0320%2FARWSS/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Cellie0320","download_url":"https://codeload.github.com/Cellie0320/ARWSS/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244868188,"owners_count":20523582,"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":["coppeliasim","css","javascript","lua","python","react"],"created_at":"2024-11-28T04:07:44.141Z","updated_at":"2025-10-07T19:11:01.241Z","avatar_url":"https://github.com/Cellie0320.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Automated Robotic Waste Sorting System (ARWSS) \n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"./PRJ371-Main-main/ARWSS/src/frontend/src/ARWSS_Logo.webp\" alt=\"ARWSS Logo\" width=\"200\"\u003e\n\u003c/p\u003e\n\n\n## Table of Contents\n1. [Installation Guide](#1-installation-guide)\n2. [Activate the Environment](#2-activate-the-environment)\n3. [Start the Front-end](#3-start-the-front-end)\n4. [Start the Back-end](#4-start-the-back-end)\n5. [Start the Simulation](#5-start-the-simulation)\n6. [Troubleshooting](#6-troubleshooting)\n7. [Frequently Asked Questions (FAQ)](#7-frequently-asked-questions-faq)\n8. [License](#8-license)\n9. [Login Credentials](#9-login-credentials-for-now-to-be-updated-in-the-near-future)\n10. [Project Group Members](#10-project-group-members-)\n\n## 1. Installation Guide\n\n### Prerequisites\n- Python 3.x\n- Node.js and npm\n- CoppeliaSim (Version 4.7.0 or higher)\n\n### 1.1 Clone the Repository\n```sh\ngit clone https://github.com/Cellie0320/ARWSS\ncd ARWSS\n```\n\n### 1.2 Install Python and Virtual Environment\n1. Download and install Python from [python.org](https://www.python.org/downloads/).\n2. Create a virtual environment in the project directory:\n    ```sh\n    python -m venv .venv\n    ```\n3. Activate the virtual environment:\n    - On Windows:\n        ```sh\n        .venv\\Scripts\\activate\n        ```\n    - On macOS/Linux:\n        ```sh\n        source .venv/bin/activate\n        ```\n4. Install the required Python packages:\n    ```sh\n    pip install -r requirements.txt\n    ```\n\n### 1.3 Install Node.js and React\n1. Install fnm (Fast Node Manager):\n    ```sh\n    winget install Schniz.fnm\n    ```\n2. Configure fnm environment:\n    ```sh\n    fnm env --use-on-cd | Out-String | Invoke-Expression\n    ```\n3. Download and install Node.js:\n    ```sh\n    fnm use --install-if-missing 22\n    ```\n4. Verify the Node.js version:\n    ```sh\n    node -v # should print `v22.0.0`\n    ```\n5. Verify the npm version:\n    ```sh\n    npm -v # should print `10.1.0`\n    ```\n6. Navigate to the `src/frontend` directory:\n    ```sh\n    cd src/frontend\n    ```\n7. Install React and React DOM:\n    ```sh\n    npm install react react-dom\n    ```\n8. Install the Node.js dependencies:\n    ```sh\n    npm install\n    ```\n9. Start the React application:\n    ```sh\n    npm start\n    ```\n\n### 1.4 Install CoppeliaSim\n1. Download and install CoppeliaSim EDU from [coppeliarobotics.com](https://www.coppeliarobotics.com/downloads). Note that the EDU version is for educational use only. For commercial use, consider using the Player or Pro version.\n2. Copy the Lua scripts to the `lua` folder in your CoppeliaSim installation directory. The Lua scripts are located in the [Lua folder directory](./PRJ371-Main-main/ARWSS/Lua).\n    ```\n    - Open CoppeliaSim\n        - File → Open Scene\n        - Navigate to the `ARWSS` directory and open the file `Group 5 simulation.ttt` in CoppeliaSim:\n            - File → Open Scene\n            - Select `Group 5 simulation.ttt`\n3. Click the Start Simulation button or press `Ctrl+P`.\n\n### 1.5 Connecting the Simulation to the Backend\n1. Ensure the Flask server is running:\n    ```sh\n    python main.py\n    ```\n2. Use the `socket.http` module in Lua to make HTTP requests to the backend. Example in `main.lua`:\n    ```lua\n    local http = require(\"socket.http\")\n    local ltn12 = require(\"ltn12\")\n    ```\n\n### 1.6 Additional Configuration\n- Refer to the [user manual](./PRJ371-Main-main/ARWSS/docs/user_manual/user_manual.md) for detailed operating instructions.\n\n## 2. Activate the Environment\n```sh\nvenv\\Scripts\\activate\n```\n\n## 3. Start the Front-end\nIn the frontend directory, you can run:\n```sh\nnpm start\n```\n\n## 4. Start the Back-end\nIn the backend directory, you can run:\n```sh\npython main.py\n```\n\n## 5. Start the Simulation\nIn CoppeliaSim, press the \"Start Simulation\" button located in the top toolbar to activate the simulation environment.\n\n## 6. Troubleshooting\n\n### Common Issues\n\n#### Environment activation issues:\n- Ensure you are using the correct command for your operating system.\n- Verify that the virtual environment was created successfully.\n\n#### Front-end not starting:\n- Ensure all dependencies are installed by running `npm install`.\n- Check for any errors in the terminal and resolve them.\n\n#### Backend not starting:\n- Ensure all dependencies are installed by running `pip install -r requirements.txt`.\n- Check if the required environment variables are set correctly in the `.env` file.\n\n#### Simulation not starting:\n- Ensure CoppeliaSim is installed and the Lua scripts are correctly placed.\n- Verify that the simulation file is correctly loaded in CoppeliaSim.\n\n## 7. Frequently Asked Questions (FAQ)\n\n#### How do I change the default port for the backend server?\nYou can change the port by modifying the `main.py` file to use a different port number.\n\n#### How do I add new API endpoints?\nDefine the new endpoint in `main.py` and add the corresponding logic.\n\n#### How do I update dependencies?\n- For Python dependencies, update the `requirements.txt` file and run `pip install -r requirements.txt` again.\n- For Node.js dependencies, use `npm install \u003cpackage-name\u003e` to add new dependencies and update the `package.json` file.\n\n#### How do I deploy the frontend to a production server?\nRun `npm run build` to create a production build and deploy the contents of the `build` folder to your server.\n\n#### How do I connect the simulation to the backend?\nEnsure the Flask server is running and use the `socket.http` module in Lua to make HTTP requests to the backend.\n\n## 8. License\nLicense information found about the project in the link below:\nhttps://github.com/Cellie0320/ARWSS/blob/3d68754e8e2396d7d5aaa947e9e83052917ec3f0/LICENSE\n\n## 9. Login Credentials (for now to be updated in the near future):\n- Username: Marcel\n- Password: marcel\n\n## 10. Project Group Members :\n-Maryna Joubert\n\n-Mia Van Staden\n\n-Marcel De Lange ( Team Lead)\n\n-Mbuti Nduweni\n\n-Lehlonolo Mokoena\n\n-Lesedi Mapokane\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcellie0320%2Farwss","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcellie0320%2Farwss","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcellie0320%2Farwss/lists"}