Skip to content

🧰 [DEV ONLY PACKAGE] Mathematicator meta repository of Mathematicator Framework libraries for development purposes

License

Notifications You must be signed in to change notification settings

mathematicator-core/meta

Repository files navigation

Mathematicator Framework Meta Repository

Integrity check License: MIT PHPStan Enabled

[DEV ONLY PACKAGE] This repository is indended for easy bulk management of mathematicator-core packages.

The main purpose is to keep all mathematicator-core packages consistent.

This package is NOT intended to be loaded as a project composer dependency.

Bulk operations

# Install dependencies for all repos
composer install:all

# Update dependencies in all repos
composer update:all

# Run tests in all repos
composer test:all

# Try to fix errors in all repos
composer fix:all

# Check PHPStan rules in all repos
composer phpstan:all
  • See all available scripts in "scripts" section of composer.json.

Consistency specification

  • All repos should have the same Codestyle
    • You can check it by composer cs:all
    • All repos should have the same .editorconfig
  • All master branches should be compatible
    • Except dependent Pull requests that should be solved ASAP. (Please mark PRs as dependent if so.)
    • You can check it by composer update

Workflows

Working with meta repository

  • Clone this meta repository with all its submodules
  • Fork the repository you want to modify
  • Change origin to upstream and speficy origin as the forked repository in submodule placed in libs/*/
  • Commit and submit PRs as usual.

IDE setup

  • The recommended IDE is PHPStorm, however you can any other IDE by your preferences.
    • This repository contains .idea/ dir with PHPStorm project definition, so you can start fast with zero manual IDE setup.

Bulk operations

  • At the beginning you have to run composer install:all
  • Then run any other bulk operation, e.g. composer phpstan:all

Development documentation

See Development documentation

Contribution

Feel free to open an issue or open a Pull Request.

Mathematicator Framework tools structure

The biggest advantage is that you can choose which layer best fits your needs and start build on the top of it, immediately, without the need to create everything by yourself. Our tools are tested for bugs and tuned for performance, so you can save a significant amount of your time, money, and effort.

Framework tend to be modular as much as possible, so you should be able to create an extension on each layer and its sublayers.

Mathematicator framework layers ordered from the most concrete one to the most abstract one:

Search Modular search engine layer that calls its sublayers and creates user interface.
Vizualizator Elegant graphic visualizer that can render to SVG, PNG, JPG and Base64.
Extensions: Mandelbrot set generator
Calculator Modular advance calculations layer.
Extensions: Integral Solver , Statistics
Engine Core logic layer that maintains basic controllers, DAOs, translator, common exceptions, routing etc.
Tokenizer Tokenizer that can convert string (user input / LaTeX) to numbers and operators.
Numbers Fast & secure storage for numbers with arbitrary precision. It supports Human string and LaTeX output and basic conversions.

Third-party packages:

⚠️ Not guaranteed!

REST API Install the whole pack as a REST API service on your server (Docker ready) or access it via public cloud REST API.

About

🧰 [DEV ONLY PACKAGE] Mathematicator meta repository of Mathematicator Framework libraries for development purposes

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages