An attendance recorder app for teachers, build for Android using Kotlin. This project is a part of Android Study Jams 2021 @ GDSC-NITA.
The current system requires teachers to carry huge attendance registers for maintaining the record for attendance, which makes the record making cumbersome and also waster paper. This app aims to eliminate the need to maintain attendance registers and make the process digital.
The project proposes a "Attendance Pad" to keep track of the attendance of students. The app will support to add multiple classes and add multiple students in a particular class. The app will also store the data locally using SQLite.
- Jetpack Navigation Component: The application has 2 screens, which was implemented using jetpack navigation component, the application is also using the safe args plugin for passing arguments to other fragment.
- Constraint Layout : Most of the activities in the app uses a flexible constraint layout, which is easy to handle for different screen sizes.
- Recycler View: Both the screens of the application uses a recycler view to show a list of required items.
- LiveData & Room Database: The app persists the data using SQLite using the room api. The viewmodel has live data, which makes the data updation smooth.
- Simple and easy View Designs: Seperate files for different dialog boxes, most of them using Material Design Guidelines makes the UI for the app smooth.
You can access the application from here. We have planned to incluce more functionalities like storing the data on the cloud, in case the user's phone is running low on storage, next the functionality to make PDF for the attendance.
The team wants to make contributing to this project as easy as possible, whether it's:
- Reporting a bug 🐛
- Submitting a fix 🔎
- Proposing new features 💡
This doc contains a set of guidelines to help you during the contribution process. We are happy to welcome all the contributions from anyone willing to improve/add new features to this project.
- Download and install the latest version of Git.
- Create a GitHub account.
- Download and install latest version of Android Studio.
- Fork this repository
- Clone the forked repository
git clone https://github.com/<your-github-username>/attendancepad.git- Navigate to the project directory
cd attendancepad- Add reference to the original repository
git remote add upstream https://github.com/DSC-NITA/attendancepad.git- Always take a pull from the upstream repository to your
mainbranch to keep it at par with the main project(updated repository).
git pull upstream mainOnce done with the above steps you are good to go for contributing. See the section below for more details.
- Create a new branch (DO NOT name it MAIN or MASTER or anything random).
git checkout -b <your_branch_name>-
Perfom your desired changes to the code base.
- Make sure that you do not change any code unrelated to the task that you have been assigned
- Preview your changes and test them properly before proceding ahead.
-
Add your changes to the project's version control
git add .- Commit your changes
git commit -m "Your commit message"- Push the committed changes in your feature branch to your remote repo.
git push -u origin <your_branch_name>- To create a pull request, click on
compare and pull requests. Please ensure you compare your feature branch to the desired branch of the repo you are suppose to make a PR to.
-
Then add an appropriate title and description to your pull request that explains your changes and efforts done.
-
Click on
Create Pull Request.- Make sure to refer the respective issue in the respective PR using phrases like Resolves #issue_number or Closes #issue_number or Fixes #issue_number. Here's an example to raise a PR:
Fixes #21
# Work Done:
- Fixed home-page renderning and jagging issue
- ...
- ...
- ...
# Relevant Screenshots/Gifs
- Wo-Hoo!! You have made an PR to the attendance-pad app. Sit back and relax while the maintainers review the PR.