Guardian Angel

A Socially Relevant Project for college semester

Done by

• Mugilan E.S. - Github
• Nivethithaa M - Github
• Shalini N - Github

Project Link

Guardian Angel Source Code

How to Run the app

1. Git clone the project into your local computer

   git clone https://github.com/Mugilan-Codes/guardian-angel
   

2. Move into the project directory

   cd guardian-angel

3. Add config.js and google-services.json file to the root of the project(firbase connection)

   config.js

   export const firebaseConfig = {
       apiKey: "<API_KEY>",
       authDomain: "<AUTH_DOMAIN>",
       databaseURL: "<DATABASE_URL>",
       projectId: "<PROJECT_ID>",
       storageBucket: "<STORAGE_BUCKET>",
       messagingSenderId: "<MESSAGING_SENDER_ID>",
       appId: "<APP_ID>",
       measurementId: "<MEASUREMENT_ID>",
   };

4. Install the App Dependencies

   npm ci

5. Run the app

   npm start

How to Contribute

1. Checkout the master branch (never directly push to master)

   git checkout master
   

2. Fetch the latest commits

   git fetch origin
   

3. Reset Local copy to match remote master

   git reset --hard origin/master
   

4. Create and checkout a new feature branch (use this format).

   git checkout -b <your-name>/<feature-name>
   

   eg. git checkout -b mugilan/map-integration

5. Make Changes and Commit those changes

   git status
   git add <file-name>
   git commit -m "<some-meaningfull-commit-message>"
   

6. Push the changes to remote

   git push -u origin <your-name>/<feature-name>
   

7. Go to Github to make a PR(Pull Request). Submit PR with Meaningfull comments. Wait for approval and merge.

8. Delete Local Branches Safely. (checkout master branch)

   git branch -d <your-name>/<feature-name>
   

9. Sync with the remote branches by pruning deleted remote branches

   git fetch -p
   

TODO

• Separate API
• Eject from Expo
• Clean the Codebase
• Refactor
• Better Database Solution / Implement Firebase to full extent