runtime

README

Certainly! Here's a README file for your "Apni University" Go application:

---

Apni University: University Management System

Overview

"Apni University" is a comprehensive University Management System designed to streamline the administrative processes of educational institutions. This Go-based application embraces a modular approach, employing a five-layer architecture to handle essential university operations effectively. Built with containerization in mind, it is easily deployable and scalable.

Features

Five Layer Architecture

The system is meticulously structured using a five-layer architecture to ensure modularity, ease of maintenance, and robustness. Each layer serves a distinct purpose, enhancing the application's efficiency and scalability.

1. Account: Manages Financial information of teacher and students.
2. Student: Handles student-related operations such as enrollment, grades, and personal information.
3. Teacher: Facilitates management of faculty details, courses taught, and classes assigned to them.
4. Subject: Manages the subjects offered, class details, and students.
5. Class: Organizes class details, student assignments, and related administrative tasks.

Database and Endpoints

The application uses a MongoDB database to store and manage data efficiently. Endpoints are generated using Go Swagger, ensuring a well-defined API structure, making integration and interaction seamless.

Installation and Deployment

Prerequisites

• Go environment set up
• Docker installed
• MongoDB installed and configured

Steps to Run

1. Clone the repository:

   git clone https://github.com/HaziqAliSohail/ApniUniversity
   

2. Navigate to the project directory:

   cd ApniUniversity
   

3. Run the application using Docker:

   docker-compose up
   

4. Access the application through the specified endpoint.

Usage

Once the application is running, you can interact with the different services using the defined endpoints. These services are designed to manage various aspects of a university, providing a user-friendly interface for administrators, faculty, and students.

Refer to the Swagger documentation for details on available endpoints and their functionalities.

Contribution

Contributions are welcome! If you'd like to contribute to the project, feel free to fork the repository and submit a pull request.

Support

For any queries, issues, or suggestions, please open an issue on the GitHub repository.

---

Feel free to enrich this with more specific details, installation instructions, and guidelines for contributors, if necessary. The README serves as a crucial introduction to your project, so make sure it's clear, concise, and informative.

Documentation

Index

• type Runtime
  • func NewRuntime() (*Runtime, error)
  • func (r Runtime) Service() *service.Service

Types

type Runtime

type Runtime struct {
	// contains filtered or unexported fields
}

func NewRuntime

func NewRuntime() (*Runtime, error)

func (Runtime) Service

func (r Runtime) Service() *service.Service