{"id":18544619,"url":"https://github.com/instructure/mathman","last_synced_at":"2025-09-10T23:43:44.552Z","repository":{"id":38238648,"uuid":"85998759","full_name":"instructure/mathman","owner":"instructure","description":"A simple lambda function that converts LaTeX formulae to MathML and SVG.","archived":false,"fork":false,"pushed_at":"2024-03-30T01:16:39.000Z","size":26972,"stargazers_count":11,"open_issues_count":13,"forks_count":10,"subscribers_count":10,"default_branch":"master","last_synced_at":"2024-04-14T20:25:57.864Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/instructure.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2017-03-23T21:20:23.000Z","updated_at":"2024-01-05T16:12:01.000Z","dependencies_parsed_at":"2024-03-30T02:26:21.393Z","dependency_job_id":null,"html_url":"https://github.com/instructure/mathman","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/instructure%2Fmathman","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/instructure%2Fmathman/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/instructure%2Fmathman/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/instructure%2Fmathman/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/instructure","download_url":"https://codeload.github.com/instructure/mathman/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223407794,"owners_count":17140563,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-06T20:17:08.072Z","updated_at":"2024-11-06T20:17:08.702Z","avatar_url":"https://github.com/instructure.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# MathMan by Instructure\n\n## Introduction\n\nThis is a simple microservice that converts LaTeX formulae to MathML and SVG.\nIt can either be run locally via `docker-compose`, or on Amazon Lambda.\n\n## Quick start (for Docker)\n\n1. Install docker and docker-compose.\n2. Run `cp docker-compose.dev.override.yml docker-compose.override.yml`\n3. Run `docker-compose build`.\n4. Run `docker-compose run --rm web npm install`.\n5. Run `docker-compose up`.\n\nThis will launch the microservice, along with a Redis cache. The service\nis available at `http://mathman.docker`.\n\nThe API interface is `/mml?tex=\u003ctex-string\u003e` or `svg?tex=\u003ctex-string\u003e\u0026scale=\u003cscale-value\u003e`\n\nwhere:\n\n- `\u003ctex-string\u003e` is the tex code for the equation\n- `\u003cscale-value\u003e` is how much to scale the result. defaults to 1. only valid for svg.\n\n## Tests\n\n1. Run `docker-compose build` if you haven't already.\n2. Run `cp docker-compose.dev.override.yml docker-compose.override.yml`\n3. Run `docker-compose run --rm web npm install`.\n4. Run `docker-compose run --rm web npm test`.\n\n## Deploy\n\n### Package the code for lambda\n\n1. Run `docker-compose run --rm web npm install`.\n2. Run `docker-compose run --rm web ./deploy/package $(git rev-parse --short HEAD)`.\n\nThe result will be `build/lambda.zip` which can be uploaded to AWS as a\nlambda function using the mathman-deploy deployer role.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finstructure%2Fmathman","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Finstructure%2Fmathman","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finstructure%2Fmathman/lists"}