Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mpc-lab-x/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.
https://github.com/mpc-lab-x/mpc-lab-x-web
chemistry generator math mathematics nodejs physics teaching-tool
Last synced: about 1 month ago
JSON representation
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.
- Host: GitHub
- URL: https://github.com/mpc-lab-x/mpc-lab-x-web
- Owner: MPC-Lab-X
- License: gpl-3.0
- Created: 2024-09-13T21:20:11.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-11-17T03:48:08.000Z (about 2 months ago)
- Last Synced: 2024-11-17T04:28:03.525Z (about 2 months ago)
- Topics: chemistry, generator, math, mathematics, nodejs, physics, teaching-tool
- Language: EJS
- Homepage: https://mpclabx.com
- Size: 415 KB
- Stars: 0
- Watchers: 0
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](https://github.com/MPC-Lab-X/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](https://github.com/MPC-Lab-X/MPC-Lab-X-server) repository.
## Installation
1. Clone the repository:
```bash
git clone https://github.com/MPC-Lab-X/MPC-Lab-X-web.git
```
2. Install the dependencies:
```bash
npm install
```
3. Create a `.env` file in the root directory and add the following environment variables:
```env
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)
```
4. Start the server:
```bash
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](https://expressjs.com/): A fast and minimalist web framework for building Node.js applications.
- [Tailwind CSS](https://tailwindcss.com/): A utility-first CSS framework for creating custom designs without leaving your HTML.
- [KaTeX](https://katex.org/): A fast, easy-to-use JavaScript library for rendering LaTeX math equations in web applications.
- [Desmos API](https://www.desmos.com/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](LICENSE) file for details.