Skip to content

Latest commit

 

History

History
150 lines (103 loc) · 6.91 KB

README.md

File metadata and controls

150 lines (103 loc) · 6.91 KB

IES IPS CMS

Android application to manage student, teachers, HOD in college.

Build

GitHub license ktlint Twitter Follow

IES IPS CMS is a campus manager ✅ Android application 📱 to help teachers to mange students in College built to demonstrate use of Modern Android development tools. Dedicated to all Android Developers and Retrofit with ❤️.

⚙️ Features

  • Login: Allow the student, teachers, hod to login in
  • Attendance: Show, edit, take student attendance
  • Marks: Add and Update studnet marks / Student view there marks.

🚀 Technology Used

  • IES IPS Academy CMS built using Kotlin
  • API fetch using Retrofit

📸 Screenshots

Imgur image image
image image image

Built With 🛠

  • Kotlin - First class and official programming language for Android development.
  • Android Architecture Components - Collection of libraries that help you design robust, testable, and maintainable apps.
    • LiveData - Data objects that notify views when the underlying database changes.
    • ViewModel - Stores UI-related data that isn't destroyed on UI changes.
    • ViewBinding - Generates a binding class for each XML layout file present in that module and allows you to more easily write code that interacts with views.
  • Dependency Injection -
    • Hilt-Dagger - Standard library to incorporate Dagger dependency injection into an Android application.
    • Hilt-ViewModel - DI for injecting ViewModel.
  • Material Components for Android - Modular and customizable Material Design UI components for Android.
  • Retrofit - Retrofit is a type-safe REST client for Android, Java and Kotlin developed by Square. The library provides a powerful framework for authenticating and interacting with APIs and sending network requests with OkHttp.

Package Structure

cmsr.ipsacademy.net    # Root Package
.
├── data                # For data handling.
│   └── repository      # Single source of data.   
|
├── di                  # Dependency Injection             
|
├── ui                  # Activity/View layer
│   ├── viewmodel       # ViewModels
│   └── adapter         # Adpaters
│   └── fragment        # Fragnents
|
└── utils               # Utility Classes / Kotlin extensions

Architecture

This app uses MVVM (Model View View-Model) architecture.

architecture

Discuss 💬

Have any questions, doubts or want to present your opinions, views? You're always welcome. You can start discussion.

Contact

If you need any help, you can connect with me.

Mail: mohitgupta

License

MIT License

Copyright (c) 2022 Mohit Gupta

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

To Contribute to this project follow the below steps:

  • Fork this Project.

  • Clone this Project in your local:-

      git clone <Foked Repo URL>
    
  • Make your Separate Branch according to your task:

      git checkout -b "<Your Branch Name>"
    
  • Great Now you are Ready to Contribute.

How to Make Pull Request

  • To add all changed files:-

      git add .
    
  • To commit your Changes:-

      git commit -m "tag: commit message"
    
  • Note Before Push, Please Note that you Update your Local Branch with Upstream Branch

  • Update your GitHub Repo using Fetch and Merge button on your repo with Development Branch.

      git pull
    
  • To PUSH your Changes:-

      git push  
    

Contributors:

Thanks to all the contributors ❤️