Skip to content

College Connect is an Android application aimed to be a one-stop-shop for all the college needs irrespective of college and course. It aims to create a helpful platform for all college students. The app uses Material UI for an attractive interface (subject to improvement) which attracts the user to stay on the app for more time and is available …

License

Notifications You must be signed in to change notification settings

collegeconnect/CollegeConnect

Repository files navigation

College Connect

Codacy Badge Actions Status License Badge Gitter Api Level

Get it on Google Play

College Connect is an android application aimed to be a one-stop-shop for all the college needs irrespective of college and course.
It aims to create a helpful platform for all college students. It uses Firebase and SQLite to store and display the information to the user. The app uses Material UI for an attractive interface (subject to improvement) which attracts the user to stay on the app for more time.

This idea was developed for Ideathon held in BVCOE, New Delhi where it was presented to be a college app for BVCOE, New Delhi

Later it was aimed to be a third party app for every college and course in India

The app is developed using native android(Java and Kotlin both) and follows MVVM architecture. It is tightly coupled as it was developed as a project to learn Android Development.

Attendence Manager

The app has an integrated Attendance Manager which uses Room Library and SQLite Database to store and retrieve data and display it in a graphical manner which looks appealing and convenient to track your attendance.

Notes

The Notes tab provides notes uploaded by students. The recycler view shows the name of the author with a total number of downloads and relevant tags.

Upload Notes and My Files

The upload notes area provide for easy upload of notes by users. It takes the authors name to give credit to the author.

The number of downloads will encourage students to make more impressive notes and create a sense of healthy competition.

The My Files section enables easy management of the notes uploaded by the users as well as the notes downloaded by the user.

Timetable

This feature allows the user to store their timetable in an ingenious and orderly fashion. It also indicates the current ongoing class. It requires the user to enter the class details consisting of subject name, start time, end time and the room number. We're constantly working on to make this feature more interactive and seamless.

Tools

  • Room Locator
    The room locator tab implements the room locator build by the DSC BVP team. Currently, it only works for BVCOE, New Delhi but we plan to expand it using the help of a wide network of DSCs present all over India
  • Upcoming Events
    It shows the upcoming events around you and their details along with an option to register from within the application.
  • Project Collaboration
    This tool help to procreate a platform where different developers can come and work together on any projects. Just list your project and get collaborators. This feature is currently under development.

Settings

  • View and edit personal profile details
  • View downloaded files
  • View uploaded files
  • View and edit professional profile

Contributions Best Practices

For first time Contributors

First-time contributors can read CONTRIBUTING.md file for help regarding creating issues and sending pull requests.

Branch Policy

We have the following branches

  • development
    All development goes on in this branch. If you're making a contribution, you are supposed to make a pull request to development. For PRs to be accepted to the development branch they must pass a build check and a unit-test check following which an apk will be generated under action artifacts for testing.
  • master
    This contains shipped code. After significant features/bugfixes are accumulated on development, we make a version update and make a release.

Code practices

Please help us follow the best practices to make it easy for the reviewer as well as the contributor. We want to focus on the code quality more than on managing pull request ethics.

  • Single commit per pull request
  • Reference the issue numbers in the commit message. Follow the pattern Fixes #
  • Follow uniform design practices. The design language must be consistent throughout the app.
  • The pull request will not get merged until and unless the commits are squashed. In case there are multiple commits on the PR, the commit author needs to squash them and not the maintainers cherrypicking and merging squashes.
  • If the PR is related to any front end change, please attach relevant screenshots in the pull request description.

Join the development

  • Before you join the development, please set up the project on your local machine, run it and go through the application completely. Press on any button you can find and see where it leads to. Explore. (Don't worry ... Nothing will happen to the app or to you due to the exploring 😉 You'll be more familiar with what is where and might even get some cool ideas on how to improve various aspects of the app.)
  • If you would like to work on an issue, drop in a comment at the issue. If it is already assigned to someone, but there is no sign of any work being done, please free to drop in a comment so that the issue can be assigned to you if the previous assignee has dropped it entirely.

License

This project is currently licensed under the Apache License Version 2.0. A copy of LICENSE should be present along with the source code.

Maintainers and Developers

This repository is owned and maintained by

About

College Connect is an Android application aimed to be a one-stop-shop for all the college needs irrespective of college and course. It aims to create a helpful platform for all college students. The app uses Material UI for an attractive interface (subject to improvement) which attracts the user to stay on the app for more time and is available …

Topics

Resources

License

Stars

Watchers

Forks