The Hub for Discovering Recycling Centers (TBD)

YoungWonks Open Source Project Summer 2022

Our project, NAME, taking place over the summer of 2022, second iteration of our open source initiative built by YoungWonks students to put their coding skills to work towards benefitting the community.

We, at YoungWonks, always believe in contributing towards a good cause in society. The coding skills of our students put us in a place where they can contribute in a way that has a social impact. It is with this in mind, that the students of YoungWonks have decided to engage in a socially beneficial open source coding real-world production level project.

Clone the code repository

git clone https://github.com/YoungWonks/ywsos2022.git
cd ywsos2022

Prerequisites

Backend:

• Python > 3.8 (NOTE: MacOS and Linux users should use the python3 command, while Windows users should use python)

Frontend:

• NodeJS > 16.1

Mobile:

• Flutter > 3.4
• Android Studio for Android development on Windows, MacOS, or Linux OR Xcode for iOS development on MacOS

Setting up Environment Variables (TODO)

Setting up the Web Frontend (Client Folder)

cd client
npm install
npm run dev

Navigate to the URL displayed in the terminal in your web browser of choice.

Setting up the Mobile Frontend (Mobile Folder)

Make sure to run flutter doctor and fix any issues with the SDK installation. Then, launch your emulator from either Android Studio or Xcode.

cd mobile
flutter pub get
flutter run lib/main.dart

Setting up the Server Backend (Server Folder)

WINDOWS:

python -m venv server/venv
.\server\venv\Scripts\activate
pip install -r server/requirements.txt
python server/main.py

MAC/LINUX:

python3 -m venv server/venv
source server/venv/bin/activate
pip3 install -r server/requirements.txt
python3 server/main.py

Navigate to the URL displayed in the terminal in your web browser of choice.

NOTE: When testing locally, the backend server should be running alongside the frontend platform being worked on.