Skip to content

MPC-Lab-X-web is the frontend component of the MPC-Lab-X project, built using Express. It provides a user interface for generating and solving questions in mathematics, physics, and chemistry. This application is designed to interact with the backend services and deliver solutions through a straightforward web interface.

License

Notifications You must be signed in to change notification settings

mhs-club/MPC-Lab-X-web

 
 

Repository files navigation

MPC-Lab-X-web

MPC-Lab-X-web is the frontend component of the MPC-Lab-X project, built using Express. It provides a user interface for generating and solving questions in mathematics, physics, and chemistry. This application is designed to interact with the backend services and deliver solutions through a straightforward web interface.

Features

  • User-friendly interface for generating and solving questions.
  • Supports multiple subjects, including mathematics, physics, and chemistry.
  • Provides detailed solutions and explanations for each question.
  • Uses Express.js for server-side rendering and API handling.
  • Supports user authentication and session management.

Prerequisites

  • Node.js
  • A Desmos API key (required for graphing)
  • Backend services (MPC-Lab-X-server)

Note: This project is part of the MPC-Lab-X project. To use this application, you must have the backend services up and running. And configure the backend services URL in the /public/js/app.js file (default: /api). For more information, refer to the MPC-Lab-X-server repository.

Installation

  1. Clone the repository:
git clone https://github.com/MPC-Lab-X/MPC-Lab-X-web.git
  1. Install the dependencies:
npm install
  1. Create a .env file in the root directory and add the following environment variables:
PORT=3000 # Port number for the server (default: 3000)
HOST=localhost # Host address for the server (default: localhost)
DESMOS_API_KEY=dcb31709b452b1cf9dc26972add0fda6 # API key for Desmos API (required for graphing)
  1. Start the server:
npm start

Acknowledgements

We would like to express our gratitude to the following libraries and tools that have greatly contributed to the success of this project:

  • Express.js: A fast and minimalist web framework for building Node.js applications.
  • Tailwind CSS: A utility-first CSS framework for creating custom designs without leaving your HTML.
  • KaTeX: A fast, easy-to-use JavaScript library for rendering LaTeX math equations in web applications.
  • Desmos API: A powerful API for integrating advanced graphing capabilities into your web applications.

License

This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details.

About

MPC-Lab-X-web is the frontend component of the MPC-Lab-X project, built using Express. It provides a user interface for generating and solving questions in mathematics, physics, and chemistry. This application is designed to interact with the backend services and deliver solutions through a straightforward web interface.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • EJS 68.2%
  • JavaScript 31.7%
  • CSS 0.1%