https://github.com/mugilan-codes/guardian-angel
https://github.com/mugilan-codes/guardian-angel
college-project expo-cli react-native
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/mugilan-codes/guardian-angel
- Owner: Mugilan-Codes
- Created: 2020-09-23T07:07:28.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-02-20T03:20:49.000Z (over 4 years ago)
- Last Synced: 2025-06-07T07:38:23.665Z (about 1 year ago)
- Topics: college-project, expo-cli, react-native
- Language: JavaScript
- Homepage:
- Size: 2.39 MB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Guardian Angel
## A Socially Relevant Project for college semester
### Done by
- Mugilan E.S. - [Github](https://github.com/Mugilan-Codes)
- Nivethithaa M - [Github](https://github.com/Nivethithaa-M)
- Shalini N - [Github](https://github.com/Shalini-CEG)
> Project Link
[Guardian Angel Source Code](https://github.com/Mugilan-Codes/guardian-angel)
#### How to Run the app
1. Git clone the project into your local computer
```git
git clone https://github.com/Mugilan-Codes/guardian-angel
```
1. Move into the project directory
```zsh
cd guardian-angel
```
1. Add config.js and google-services.json file to the root of the project(firbase connection)
> config.js
```js
export const firebaseConfig = {
apiKey: "",
authDomain: "",
databaseURL: "",
projectId: "",
storageBucket: "",
messagingSenderId: "",
appId: "",
measurementId: "",
};
```
1. Install the App Dependencies
```zsh
npm ci
```
1. Run the app
```zsh
npm start
```
#### How to Contribute
1. Checkout the master branch (never directly push to master)
```git
git checkout master
```
1. Fetch the latest commits
```git
git fetch origin
```
1. Reset Local copy to match remote master
```git
git reset --hard origin/master
```
1. Create and checkout a new feature branch (use this format).
```git
git checkout -b /
```
eg. `git checkout -b mugilan/map-integration`
1. Make Changes and Commit those changes
```git
git status
git add
git commit -m ""
```
1. Push the changes to remote
```git
git push -u origin /
```
1. Go to Github to make a PR(Pull Request). Submit PR with Meaningfull comments. Wait for approval and merge.
1. Delete Local Branches Safely. (checkout master branch)
```git
git branch -d /
```
1. Sync with the remote branches by pruning deleted remote branches
```git
git fetch -p
```
#### TODO
- Separate API
- Eject from Expo
- Clean the Codebase
- Refactor
- Better Database Solution / Implement Firebase to full extent