/mvc-dashboard-example

Example of simple sales dashboard app built on top of custom MVC

Primary LanguagePLpgSQL

⚠️ Important: do not use in production! This repo contains sample code ⚠️

Introduction

Example of sales dashboard built on top of simple MVC

Requirements

  • Docker
  • docker-compose

Installation

Copy .env.example into .env inside www directory

$ cd www
$ cp .env.example .env

Build Docker images inside .docker directory

$ cd .docker
$ docker-compose build

# Start the containers
$ docker-compose up -d

Install Composer dependencies

$ docker-compose exec php-fpm composer install

Upload SQL data

$ docker-compose exec -T mariadb mysql -udefault -psecret default < ../database.sql

Details

  • Docker containers are in .docker folder (nginx, mariadb and php8-fpm)
  • www folder contains code
  • Routes are in www/routes/routes.php
  • Only GET and POST supported for now
  • Controllers are invokable, i.e. method __invoke(RequestInterface $request) is mandatory
  • Frontend: Bootstrap 5.1.0 + ChartJS for graph

Example view

Check code quality
$ docker-compose exec php-fpm composer lint