Giter VIP home page Giter VIP logo

prepmaster-api's Introduction

Prepmaster API

Prepmaster API is a Spring Boot application developed as a Maven project. It provides a backend solution for the Prepmaster website, a practice exam platform designed for students preparing for the exit exams in Ethiopian Universities.

Technologies Used

  • Java
  • Spring Boot
  • Maven
  • PostgreSQL
  • Render.com (API Hosting)

Dependencies

The following dependencies are used in this project:

  • Spring Boot Web: Used for building RESTful APIs and handling HTTP requests.
  • Spring Boot Data JPA: Provides support for data access using Java Persistence API (JPA) and Hibernate.
  • PostgreSQL Driver: Enables connectivity between the application and the PostgreSQL database.

Architecture

Prepmaster API follows the full N-tier architecture, ensuring a clear separation of concerns and modularity. The architecture consists of the following layers:

  • Presentation Layer: Handles the presentation logic, including REST controllers and DTOs.
  • Service Layer: Implements the business logic and coordinates the flow of data between the presentation and data access layers.
  • Data Access Layer: Interacts with the PostgreSQL database using JPA repositories.

Getting Started

To set up the Prepmaster API locally, follow these steps:

  1. Clone the repository: git clone https://github.com/your-repo/prepmaster-api.git
  2. Navigate to the project directory: cd prepmaster-api
  3. Build the project: mvn clean install
  4. Configure the PostgreSQL database connection in the application.properties file.
  5. Run the application: mvn spring-boot:run

Database ERD

Here is the Entity Relationship Diagram (ERD) for the Prepmaster API database:

EERD for PrepMaster

UI Show-Off

Prepmaster website provides a user-friendly interface for students to access practice exams. Below is a screenshot of the UI:

Splash Screen

Sample Questions

FAQ

The frontend implementation can found in this repo: https://github.com/MohammedIbrahim8887/PrepMaster

Production Deployment

To deploy the Prepmaster API to the Renderer hosting service, follow these steps:

  1. Set up an account on the Renderer platform.
  2. Create a new project and configure the necessary settings.
  3. Generate a production-ready JAR file: mvn clean package
  4. Upload the JAR file to the Renderer platform.
  5. Configure the environment variables and database connection in the Renderer settings.
  6. Start the API on the Renderer platform.

API Documentation

For detailed API documentation and endpoints, please refer to the Swagger UI or Postman collection provided.

prepmaster-api's People

Contributors

abel-cosmic avatar dagno1 avatar mohammedibrahim8887 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.