diff --git a/README.md b/README.md index f0a2594..087acc0 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,34 @@ # receipt-plus ## Team Members: -* David Ye -* Aarnav Gogri -* Kyunghyun Kim -* Joshua Yoo -* Suyash Pandit -* Carl Pontino + +- David Ye (PM & Backend Lead) +- Joshua Yoo (Frontend Lead) +- Aarnav Gogri (Backend Dev) +- Suyash Pandit (Backend Dev) +- Sam Shin (Club Lead PM) +- Kyunghyun Kim +- Carl Pontino + +## Environment Setup: + +# Recommendations + +- Install Expo Go on mobile device +- Develop inside a virtual environment (recommend Conda) + +# Frontend Setup + +``` +npm install +cd .\source\frontend\ +npx expo start -c +``` + +# Backend Setup + +``` +pip install -r requirements.txt +cd .\source\backend\ +flask --app server_main run +```