README.md

Ryzen Controller Preset API

Install development environment

make install

See the Makefile to know what make install is doing.

You may need to restart your browser to have a fully working https environment.

Development architecture description

Legend:

graph LR
    subgraph container name
    bin[folder binary action]
    end

Loading

Graph:

graph LR
    subgraph reverseproxy
    reverseBin[none traefik serve]
    end

    subgraph yarn
    yarnBin[./app yarn none]
    end

    subgraph admin
    adminBin[./admin yarn start]
    end

    subgraph app
    nginx[./app nginx serve]
    end

    subgraph php
    appBin[./app php serve]
    end

    subgraph db
    postgres[none postgres serve]
    end

    reverseBin --- nginx
    reverseBin --- adminBin
    nginx --- appBin
    adminBin --- nginx
    appBin --- postgres

Loading

• yarn:
  • This allows us to use webpack encore (https://symfony.com/doc/current/frontend.html)
  • More information: https://classic.yarnpkg.com/en/docs
  • Toolset:
    • yarn: make yarn [install]
• reverseproxy: http:https://localhost:8080/
  • Traefik: https://docs.traefik.io/v2.0/
  • This allow us to have a working domain *.ryzencontroller.localhost with TLS enabled.
• api: https://api.ryzencontroller.localhost/
  • The symfony app, using api-platform
  • More information: https://api-platform.com/docs/core/
  • Toolset:
    • composer: make composer [help]
    • bin/console: make console [list]
    • shell: make shell [sh]
• admin: https://admin.ryzencontroller.localhost/
  • React-admin: https://marmelab.com/react-admin/Readme.html
  • This allow developers to manage and easily test the API
  • For development purpose only, not intended to be in production
  • Toolset:
    • yarn: make admin-yarn [help]
• db: tcp:https://localhost:5432/
  • PostgreSQL: https://www.postgresql.org/docs/
  • The project's database
  • Toolset:
    • psql: make db-psql [--help]

Troubleshoot

Using make, I'm getting --argument not recognize errors.

If using --arguments, you must use make like this: make -- action --arguments.