search

Mission-Prerna / Nipun-Lakshya-App

Public repo of the Nipun Lakshya Android App used by teachers, examiners, mentors & parents to help students prepare for and perform assessments in Uttar Pradesh, India.
4 stars 9 forks source link
android firebase kotlin social-impact

readme

Nipun Lakshya Android application

The Nipun Lakshya Android Application is used by parents, teachers, examiners and mentors. With the app parents & teachers can help students prepare for assessments. Mentors can perform assessments using the app.

The application is predominantly written in Java with newer elements in Kotlin. The app extensively uses a modified version of ODK to collect data. The app uses APIs for easier access and storage of some of our data elements. The app talks to our backend service for authentication and access control.

Installation

1. Clone the repo and submodules

Clone the repo and also update the submodules git submodule update --recursive --remote

2. Setup a NL backend instance

Follow instructions in the sandbox-deployment repo to setup the BE system to run the app.

Note: You can skip this and go to step 3.a directly

3. Create a local.properties file

Refer sample.local.properties and create a local.properties.

You can replace the creds with the endpoints you have created in step 2.

3.a. Use the sandbox endpoints instead

We have created a sandbox with the entire BE system deployed. You can copy the contents of sandbox.properties to local.properties for using the sandbox environment & easier setup of the app.

4. Create a Firebase project

Create a new project on Firebase.

Remember to check "Enable Google Analytics for this project" in the Step 2.

4.a. Create & place a project google-services.json file

  1. Open the Firebase project created in the above step.
  2. Register an Android app with package name org.samagra.missionPrerna
  3. Download & Place the google-services.json in app folder.

4.b. Create & place an odk google-services.json file

  1. Add another Android app to the same Firebase project
  2. Add package name as org.odk.collect.android
  3. Download & place the google-services.json in collect_app folder

5. Run the app & contribute back!

Run the app, enjoy and contribute!

Note:

Credentials to be used

Teacher profile - 9999999999
Examiner profile - 9999999998
Mentor profile - 9999999997

Default OTP for the above profile - 9876