Skip to content

Latest commit

 

History

History
92 lines (64 loc) · 5.54 KB

README.md

File metadata and controls

92 lines (64 loc) · 5.54 KB
Raw

Issues Pull Requests License Gitter

InstiGo-Android

InstiGo is an android app for the students and faculties of IIT Dharwad that provide a one stop solution for matters related to mess, academia and hostel.

InstiGo_cover

InstiGo apk

button

Libraries Used

  • Firebase - Firebase is Google's mobile platform that helps you quickly develop high-quality apps
  • Glide - An image loading and caching library for Android focused on smooth scrolling
  • KensBurnView - Android ImageViews animated by Ken Burns Effect
  • Boom Menu - A menu which can ... BOOM! - Android
  • Butterknife - View "injection" library for Android
  • RxJava - Reactive Extensions for the JVM – a library for composing asynchronous and event-based programs using observable sequences for the Java VM.

Project Setup

After cloning the project, you need to replace the existing Firebase json file with yours. Follow the steps below to add json file to your project:

  1. Create Firebase account and go to console ( it is present in upper right side of main website).
  2. Click on New Project. A dialog box opens up. Give a suitable name and click on Create Project.
  3. In the new window, where you have to select the platform in which you want to add Firebase, select Android.
  4. Register app window opens. Fill the details.
    Package Name : com.iitdh.sonusourav.instigo
    App Nickname : InstiGo
    Debug Signing Certificate SHA-1 : Add your own SHA-1 key. Follow the steps if you don't know how to do so.

SHA-1 Key
(a) Click on Gradle tab in the right side of Android studio.
(b) Click on Android and then signingReport.
(c) Run window will open up in which SHA-1 key will be mentioned.
(d) Copy and paste it on the required field in Firebase.

SHA-1 Key2

  1. Click on Register App button.
  2. Download the json file and replace the existing file with yours. ( For that switch from Android mode to Project in Android Studio)
    Project mode
  3. Build the project in Android Studio. And click OK in Firebase and the project is created.
  4. Next when the below window opens, go to Sign-in Method in Authentication tab.

firebase

  1. Enable Email and Password and Google Sign-In.
  2. Setup Realtime Database from Database tab. Make sure you have the following rules in your rules section of database.

{ "rules": { ".read": "auth != null", ".write": "auth != null" } }

  1. Similarly, setup Firebase Storage from Storage tab. Check the rules again.

service firebase.storage { match /b/{bucket}/o { match /{allPaths=**} { allow read, write: if request.auth != null; } } }

Contributing

Before contributing be sure to check out the CONTRIBUTION GUIDELINES guidelines.

We currently have a series of automated Unit and Integration tests. These can be run locally and are also run when submitting a pull request.

Code Style

For contributions please read the CODESTYLE carefully. Pull requests that do not match the style will be rejected.

Commit Style

For writing commit messages please read the COMMITSTYLE carefully. Kindly adhere to the guidelines. Pull requests not matching the style will be rejected.

Communication

Our other sources of communications include

LEGAL & DISCLAIMER

Please refer to LICENSE.