Skip to content

Environment

Jump to bottom
gamefamorg edited this page Nov 9, 2024 · 4 revisions

Environment

Welcome to the ExamApp project repository! This section provides the necessary setup and environment details for developers working on the Client part of the project.

Project Overview

The ExamApp project consists of two main parts: Client and Server. They interact via API calls, with the Server exposing a private API that the client communicates with.

  1. Client:

    • The client is developed using classic PHP (compatible with PHP 5.6 and above). This ensures the application can be easily deployed in a wide range of hosting environments.
    • Frontend is built using HTML, CSS, JavaScript, and popular libraries like Bootstrap, MathJax (for math formula rendering), and CKEditor (for rich-text editing).
    • The client can be developed and hosted on any server you control. Feel free to customize, extend, and deploy it on your own infrastructure.

  2. Server (API):

    • The API server is private, and its documentation is provided separately. To interact with the server, you will need to refer to the API documentation for endpoints and authentication details.
    • You’ll need to create an account on the platform to log in and obtain a token for API access. The token is used to authenticate API requests, ensuring secure communication between the client and server.

Technologies Used

  • Backend/Client: PHP 5.6+ (classic PHP for wide compatibility)
  • Frontend: JavaScript, HTML5, CSS3, Bootstrap, MathJax, CKEditor
  • Server: The Client can be hosted on your choice of server platform, compatible with Apache2 or Nginx.

Server Hosting and Deployment

  • The client is designed to work seamlessly on Apache2 or Nginx servers, so you have flexibility when choosing your hosting environment.
  • The codebase can be deployed on any system you control or prefer, giving you full freedom in terms of hosting and scaling your application.

Lightweight and Efficient

  • ExamApp is designed with performance in mind. The client-side code is lightweight, ensuring quick loading times and a smooth user experience, even with lower server resources.
  • The app is optimized for low-overhead and quick deployment, ideal for environments with limited resources.

API Authentication

  • To get started with the API, you'll need to register by referring to the API documentation. The registration will provide you with a token, which is required for all API interactions.
  • Please note that API access is private, and documentation for interacting with the API is available in the repo under the API Documentation section.
Clone this wiki locally