Skip to content

Latest commit

 

History

History
53 lines (37 loc) · 3.38 KB

CONTRIBUTING.md

File metadata and controls

53 lines (37 loc) · 3.38 KB
Raw

Contributing 👨‍💻

How to contribute

  • Take a look at the existing Issues or create a new issue!
  • Fork the Repo. Then, create a branch for any issue that you are working on. Finally, commit your work.
  • Create a Pull Request (PR), which will be promptly reviewed and given suggestions for improvements by the community.
  • Add screenshots or screen captures to your Pull Request to help us understand the effects of the changes proposed in your PR.

Setup && Installation

  1. Fork the repository and clone it.
  2. Install the project using npm i.
  3. Run the project using npm start.
  4. Create a new branch using git checkout -b <branch_name>

Firebase(mandatory)

  • Go to Firebase Console and create a new project with any name(Do not enable the google anlytics for the project if asked )
  • Go to project overview under General tab scroll down add app select web and then copy the firebaseconfig(dont try below its deleted already)

Fire Base Config Screenshot

  • create a .env file in the root of the folder ,go to project overview in firebase under Cloud Messaging Generate key pair copy the key and replace it with VAPID_KEY in .env

  • also replace the firebaseConfig in the firebase-messaging-sw.js & firebase.js with your credentials

  • Again go to project overview under Cloud Messaging Generate key pair copy the key and replace it with VAPID_KEY in .env

  • for more details check out FCM DOCS

Cloudinary(mandatory)

  • Create a Cloudinary account, then create a product environment.
  • In access keys generate a new access key image
  • In Upload create a new upload preset image
  • Paste the key and upload preset name in the .env file view .env.sample

Cognitive Services(AI)(optional)

  • in our app we have two ai models one which detects the animal type and number of animals in the image another one detects the type of injury of the animal ( external injuries)
  • we are not making the endpoints public due to some safety reasons , but our apps works smoothly without those end points locally so you will not face any issues

Naming Conventions

  • Pages under pages folder and components under components folder must be named in PascalCase
  • utility function, hooks , context should be names in camelCases

System Design

Gssoc'24

issues under gssoc24 time alloted is 5 days . if a issue needed more time we will mention it while assigning after alloted time is passed if no update is given issue will be assigned to other contributor