Skip to content

README.md

Latest commit

 

History

History
87 lines (64 loc) · 2.22 KB

README.md

File metadata and controls

87 lines (64 loc) · 2.22 KB
Raw

MathBit

This is a Maturita project monorepo for a web app that is used for visually teaching and displaying mathmetical expressions running on a haskell engine

Prerequisites

  • Node.js >=18.17
  • Docker
  • GCHUB

Installation

Clone the repository and install dependencies: There are specific installations and instructions for each package of the monorepo; for these refer to docs/.md files in each package

pnpm install

Development

To develop the app and packages locally, run the following commands:

Build requiered images Build

docker compose up -d

Generate routes

pnpm run generate:api

Then rename all .env.prod files back to .env and change the URLs to localhost ports of your choosing for example, note engine should run on 8080

WEB_APP_URL=http://localhost:4000
WEB_API_URL=http://localhost:4001

Run the packages

pnpm run dev

Running the engine is also needed

pnpm engine

Build

To build the app and packages, run the following command:

pnpm build

Project Structure

Project consists of four pnpm packages and one standalone package

  • web-app React Router based frontend and UI toolkit
  • web-api TSOA/Swagger api specification that generates an SDK
  • web-api-client API client that generates typed routes used on the frontend from the Swagger SDK
  • db Kysely based db library that contains table, and repository specifications used to make requests to a Postgres db container
  • haskell-engine Standalone HTTP-microservice that handles math computations, it exposes a simple GET/POST API
  • tests Test suites for the whole application, including unit tests, integration tests, and end-to-end tests

App folder structure

├───web-app
├───web-api
├───web-api-client
├───db
├───haskell-engine
├───tests

each package has a /docs folder at root that contains more specific documentation & instuctions for each package

Utilities

This project has some additional tools already setup for you: