satyamroy001 / amritaresource

An android App which contains some PDFs of classes notes of particular department of particular subject 🎓

Amrita Resource 🎓 🏫

A platform for University Students to share Documents such as Exam Papers and Study Material. Users can Upload/Download Documents shared by Users.

Pre-requisites

• Android SDK v28
• Android Build Tools v28.0.0
• Android Support Repository v23.3.

These components can be downloaded bundled at the Android studio IDE

Tech Stack

• Java
• Android SDK
• Firebase SDK

Libraries Used

• Architecture Components
• CustomFloatingActionButton
• DebugDB
• Dexter
• Firebase-Firestore
• Firebase-Storage
• Firebase-UI
• Glide
• GSON
• MaterialDrawer
• Logger

Screenshots

Login Screen

Main Screen

Upload Document screen

Workflow of app

AmritaResouce
 ┣ activies
 ┃ ┣ LoginActivity.java
 ┃ ┣ MainActivity.java
 ┃ ┗ UploadActivity.java
 ┣ adapter
 ┃ ┗ UploadDocumentAdapter.java
 ┣ clicklistners
 ┃ ┗ RecyclerItemClickListener.java
 ┣ models
 ┃ ┣ SubjectModel.java
 ┃ ┣ UploadDocumentModel.java
 ┃ ┣ UploadDocumentViewmodel.java
 ┃ ┗ UserViewModel.java
 ┣ utils
 ┃ ┣ AlertDialogUtil.java
 ┃ ┣ FireStoreQueryLiveData.java
 ┃ ┗ NetworkUtil.java
 ┣ MainApplication.java
 ┗ webViewActivity.java
 

Setting up your development environment

• Download and install Git

• Fork the Amrita Resource project

• Clone your fork of the project locally. At the command line:

  $ git clone https://github.com/YOUR-GITHUB-USERNAME/AmritaResource
  

• To build this project, use the gradlew build command

If you prefer not to use the command line, you can use Android Studio to create a new project from version control using

https://github.com/YOUR-GITHUB-USERNAME/AmritaResource

and use Import Project in Android Studio to build it

If there are any missing dependencies, install them first by clicking on the links provided by Android studio. Once the project is built successfully, run the project by clicking on the green arrow at the top of the screen.

PR Instruction

This project uses Travis CI for checking pull requests. So before committing your changes, open Terminal via android studio and run the following commands:

For Windows:

• gradlew clean then
• gradlew assembleDebug assembleRelease then
• gradlew check then
• gradlew build finally
• gradlew spotlessCheck

NOTE: Currently sever is not working but update the features in the app Currently I am updating the resources for CSE and ECE departments only and that too for semester 3 only. Once I get all the resources, I will update in all departments. You can freely contribute to the project on the note that 'contributing guidelines' of the project are followed. New ideas and suggestions are welcomed. Happy Coding :)