Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
65 lines (49 loc) · 2.68 KB

CONTRIBUTING.md

File metadata and controls

65 lines (49 loc) · 2.68 KB

🤝 Contributing to Sahaay

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

If you have a suggestion that would make this better, please fork the repo and create a pull request. Please go through existing issues and pull requests to check if somebody else is already working on it.

Steps to Contribute

  1. Fork or Clone the repo git clone https://github.com/mrakesh0608/Sahaay.git or gh repo clone mrakesh0608/Sahaay
  2. Create your Feature Branch git checkout -b feature/[feature-name]
  3. Commit your Changes git commit -m 'New Feature : [feature-name]'
  4. Push to the Branch git push origin feature/[feature-name]
  5. Open a Pull Request

Setup - Front End

  • Change directory into frontend cd Sahaay/frontEnd
  • Install dependencies npm i
  • To install the EAS CLI for builds npm i -g eas-cli
  • Copy your configuration files into configs folder
    • It contains 2 files.
    • Rename to google-services.json for Android.
    • Rename to GoogleService-Info.plist for IOS.

Development Build

  • For Android, download development build apk from this link.
    OR
    Build your own development apk using npm run build-dev-apk & download it from Expo dev.
  • Install development build apk in your Android device.
  • Start metro bundler npm start
  • Start metro bundler with empty cache npm run start-c
  • To open the app, scan the QR code from Metro Bundler with Expo Go (Android) or Camera app (iOS).

Production Build - Android App

  • To build production ready apk npm run build-apk
  • Download apk from Expo dev
  • Install and run the Android build on your device.

Setup - Back End

  • Change directory into backend cd Sahaay/backEnd
  • Copy your configuration files into configs folder
    • It contains 2 files.
    • Rename to gCloud.json for Google's Vision API
    • Rename to serviceAccount.json for rest applications
  • Start Server using
# If all packages are already installed in your system
uvicorn --app-dir src server:app --reload --host [your-host-ip]

or

pipenv install
pipenv run uvicorn --app-dir src server:app --reload --host [your-host-ip]

Don't forget to give a star ⭐️ to this repository.

Thanks again 😉 !!