Initial PHP Slim project structure

.gitignore

@@ -1,23 +1,9 @@
-# ---> Go
+# Composer dependencies
-# If you prefer the allow list template instead of the deny list, see community template:
+/vendor/
-# https://github.com/github/gitignore/blob/main/community/Golang/Go.AllowList.gitignore
-#
-# Binaries for programs and plugins
-*.exe
-*.exe~
-*.dll
-*.so
-*.dylib
 
-# Test binary, built with `go test -c`
+# Local data directory
-*.test
+data/
-
-# Output of the go coverage tool, specifically when used with LiteIDE
-*.out
-
-# Dependency directories (remove the comment below to include it)
-# vendor/
-
-# Go workspace file
-go.work
 
+# Compiled CSS and JS
+public/css/
+public/js/

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) <year> <owner> 
+Copyright (c) 2022 Bit Goblin
 
 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
 

bin/run-php.sh

@@ -0,0 +1,4 @@
+#!/bin/sh
+
+# start a local instance of the app using PHP's built-in webserver
+php -S localhost:8080 -t public/ public/index.php

composer.json

@@ -0,0 +1,24 @@
+{
+    "name": "bitgoblin/colossus",
+    "description": "Self-hosted database for organizing PC hardware benchmarking results",
+    "type": "project",
+    "license": "BSD-2-Clause",
+    "autoload": {
+        "psr-4": {
+            "BitGoblin\\Colossus\\": "src/"
+        }
+    },
+    "authors": [
+        {
+            "name": "Gregory Ballantine",
+            "email": "gballantine@bitgoblin.tech"
+        }
+    ],
+    "minimum-stability": "stable",
+    "require": {
+        "slim/slim": "^4.11",
+        "slim/psr7": "^1.6",
+        "php-di/php-di": "^6.4",
+        "slim/twig-view": "^3.3"
+    }
+}

public/.htaccess

@@ -0,0 +1,5 @@
+# rewrite rules
+RewriteEngine On
+RewriteCond %{REQUEST_FILENAME} !-f
+RewriteCond %{REQUEST_FILENAME} !-d
+RewriteRule ^ index.php [QSA,L]

public/index.php

@@ -0,0 +1,24 @@
+<?php
+
+// if we're looking for static files in dev, return false so they can be served.
+if (PHP_SAPI == 'cli-server') {
+  $url  = parse_url($_SERVER['REQUEST_URI']);
+  $file = __DIR__ . $url['path'];
+
+  // check the file types, only serve standard files
+  if (preg_match('/\.(?:png|js|jpg|jpeg|gif|css)$/', $file)) {
+    // does the file exist? If so, return it
+    if (is_file($file))
+        return false;
+
+    // file does not exist. return a 404
+    header($_SERVER['SERVER_PROTOCOL'].' 404 Not Found');
+    printf('"%s" does not exist', $_SERVER['REQUEST_URI']);
+    return false;
+  }
+}
+
+require_once __DIR__ .  '/../src/app.php';
+
+$app->run();
+

src/Controllers/Controller.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace BitGoblin\Colossus\Controllers;
+
+use Psr\Container\ContainerInterface;
+
+class Controller {
+
+  protected $container;
+
+  public function __construct(ContainerInterface $container) {
+    $this->container = $container;
+  }
+
+  public function get(string $name) {
+    return $this->container->get($name);
+  }
+
+}

src/Controllers/HomeController.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace BitGoblin\Colossus\Controllers;
+
+use Psr\Http\Message\ResponseInterface as Response;
+use Psr\Http\Message\ServerRequestInterface as Request;
+use Slim\Views\Twig;
+
+class HomeController extends Controller {
+
+  public function getIndex(Request $request, Response $response): Response {
+    $view = Twig::fromRequest($request);
+    return $view->render($response, 'index.twig');
+  }
+
+}

src/app.php

@@ -0,0 +1,25 @@
+<?php
+
+use DI\Container;
+use Psr\Http\Message\ResponseInterface as Response;
+use Psr\Http\Message\ServerRequestInterface as Request;
+use Slim\Factory\AppFactory;
+use Slim\Views\Twig;
+use Slim\Views\TwigMiddleware;
+
+require __DIR__ . '/../vendor/autoload.php';
+
+// Create Container using PHP-DI
+$container = new Container();
+
+// Set container to create App with on AppFactory
+AppFactory::setContainer($container);
+$app = AppFactory::create();
+
+// Create Twig
+$twig = Twig::create(__DIR__ . '/../views', ['cache' => false]);
+// Add Twig-View Middleware
+$app->add(TwigMiddleware::create($app, $twig));
+
+// Register routes
+require_once __DIR__ . '/routes.php';

src/routes.php

@@ -0,0 +1,3 @@
+<?php
+
+$app->get('/', '\\BitGoblin\\Colossus\\Controllers\\HomeController:getIndex')->setName('dashboard');

views/index.twig

@@ -0,0 +1,9 @@
+{% extends 'layout.twig' %}
+
+{% block title %}Dashboard{% endblock %}
+
+{% block content %}
+
+<p>This is a test.</p>
+
+{% endblock %}

views/layout.twig

@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <title>{% block title %}{% endblock %} | Colossus</title>
+</head>
+<body>
+  {% block content %}{% endblock %}
+</body>
+</html>