Modelab-api

This is an API and backend for Modelab

Contents

• Modelab-api
  • Contents
  • Documentation
  • Setup
    • Prerequisites
    • Setup
    • Development
    • Other commands

Documentation

• Development - Techical overview
• Design - About the API design
• Endpoints - All API endpoints described

Setup

Prerequisites

• PHP >=7.2

1. Clone the repository
2. Make sure your MySQL DB server is on

There are many provided actions to help with setup and managment of this app.

On windows use:

./modelab.cmd ACTION

On linux use:

make ACTION

or execute them manually from /bin.

Setup

Windows:

./modelab.cmd setup

Linux:

make setup

This will check your .env and /config configurations, check the DB connection, create the data/ and logs/ folder and populate the DB with some base data.

With this, the server is ready for usage.

Development

Windows:

./modelab.cmd setup-dev

Linux:

make setup-dev

This will do what setup does and it will load some development assets.

(WIP)

Other commands

• drop-models for dropping the database models
• state-export for exporting server state (WIP)
• state-import for importing server state (WIP)