2025-02-19 19:57:46 -08:00

39 lines
858 B
Markdown

# MathU
This is a project trying to teach advanced math concepts in the form of a Visual Novel on the web.
Status: Early days, but we have a base custom Visual Novel engine and a build step for converting latex into svgs we can render.
## Dependencies
Before you can run this locally, you must install:
- node (version 18) - I recommend installing through [nvm](https://github.com/nvm-sh/nvm#nvmrc)
- [docker desktop](https://www.docker.com/)
It might also be helpful to install [pgAdmin4](https://www.pgadmin.org/) and some helpful api app like postman (I use [HTTPie](https://httpie.io/)).
## Setup
```sh
nvm use
npm install
```
Also, you have to have latex installed, to compile stuff.
## Running it!
To run the application locally...
In one tab,
```sh
npm run dev-watch-client
```
In another,
```sh
npm run dev-docker
npm run dev-server
```