Skip to content

zarrroshin/College-Management-App

Repository files navigation

Sure, here is the revised comprehensive description for your GitHub repository with the additional details you provided:


University Flutter App Project

Overview

This repository contains a comprehensive project developed for a university course. The project involves creating a Flutter application that interacts with a Java backend using server socket programming. The application is built following the MVC (Model-View-Controller) design pattern, ensuring a well-organized and maintainable codebase. The project also includes a graphical command-line interface (CLI) and uses text files for a limited university database, with SQL code integrated for future database expansion. Data transfer between the frontend and backend is handled via REST API using fetch requests for GET and POST methods.

Features

  • Flutter Frontend: A sleek and responsive user interface built with Flutter, providing a seamless user experience across different devices.
  • Java Backend: A robust backend implemented in Java, handling server-side logic and data processing.
  • Server Socket Programming: Real-time communication between the Flutter frontend and Java backend using server socket programming.
  • Graphical Command-Line Interface (CLI): A graphical CLI tool to manage and interact with the server-side components, providing an additional layer of control and functionality.
  • MVC Design Pattern: The project adheres to the MVC design pattern, promoting a clear separation of concerns and enhancing code modularity.
  • REST API: Data is transferred using fetch requests in the Flutter frontend and handled in the Java backend via GET and POST methods.

Project Structure

  • Flutter Application: Contains the code for the Flutter frontend, including UI components, state management, and network requests.

    • lib/: Main directory for Flutter code.
      • views/: UI components and screens.
  • Java Server: Contains the code for the Java backend, including server socket implementation and business logic.

    • Backend/src/main/java: Main directory for Java code.
      • controllers/: Java controllers handling incoming requests and responses.
      • models/: Data models representing server-side data structures.
      • services/: Services for processing data and managing socket connections.
      • cli/: Graphical Command-Line Interface tool for managing the server.
      • database/: Directory containing text files for the limited university database and SQL code for database operations.

Getting Started

Prerequisites

  • Flutter SDK: Ensure you have the Flutter SDK installed. Follow the instructions on the Flutter official website.
  • Java Development Kit (JDK): Ensure you have JDK installed. You can download it from the Oracle website.

Installation

  1. Clone the Repository:

    git clone https://github.com/zarrroshin/College-Management-App
    cd College-Management-App
  2. Set Up Flutter Application:

    cd flutter_app
    flutter pub get
    flutter run
  3. Set Up Java Server:

    cd java_server
    javac -d bin Backend/src/main/java/server.java

Usage

  • Flutter Application: Run the Flutter application using flutter run and interact with the UI.
  • Java Server: Use the provided graphical CLI tool to manage and interact with the server-side components.

Contributions

Contributions are welcome! Please feel free to submit a pull request or open an issue if you have any suggestions or improvements.

This description should provide a clear and detailed overview of your project, making it easy for others to understand its purpose, structure, and how to get started with it.

Concise Description for Repo


A Flutter app project for university, featuring a Flutter UI, Java backend, server socket programming, a graphical CLI, and REST API. Built with MVC design, includes text-based and SQL databases.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •