Added setup functionality

Author: hind-sagar-biswas

.env.example

@@ -1,16 +1,17 @@
-APP_NAME="PHP Route Template"
+APP_NAME="{{APP_NAME}}"
 APP_ENV=local
 APP_DEBUG=true
-APP_URL=http://localhost:8888/php_route_template
+APP_URL=http://{{APP_URL}}{{APP_ROOT}}
 
-API_ROUTE="${APP_URL}/api"
+APP_ROUTE_ROOT={{APP_ROOT}}
+API_ROUTE_ROOT=/api
 
 DB_CONNECTION=mysql
-DB_HOST=localhost
+DB_HOST={{DATABASE_HOST}}
 DB_PORT=3306
-DB_DATABASE=php_route_template
-DB_USERNAME=root
-DB_PASSWORD=
+DB_DATABASE={{DATABASE_DATABASE}}
+DB_USERNAME={{DATABASE_USERNAME}}
+DB_PASSWORD={{DATABASE_PASSWORD}}
 
 MAIL_MAILER=smtp
 MAIL_HOST=mailpit

README.md

@@ -2,7 +2,23 @@
 
 Simple template with Routing for PHP.
 
-## Preinstalled
+## Setup
+
+First clone it from github or click on [Use this template](https://github.com/new?template_name=php_route_template&template_owner=hind-sagar-biswas)
+
+```terminal
+git clone https://github.com/hind-sagar-biswas/php_route_template.git
+```
+
+**(if cloned)** Rename the folder and remove `.git` folder.
+
+Then open terminal in the folder and run
+
+```terminal
+php .\exec\setup.php
+```
+
+## Dependencies
 
 ### NPM modules
 

exec/setup.php

@@ -0,0 +1,67 @@
+<?php
+
+function get_input($prompt, $default = null)
+{
+    $default = ($default) ? "[$default]" : '';
+    $input = readline("$prompt $default: ");
+    return (trim($input) == "") ? $default : $input;
+}
+
+function print_line($text, int $multiplier = 1)
+{
+    $output_text = '';
+    for ($i = 0; $i < $multiplier; $i++) {
+        $output_text = $output_text . $text;
+    }
+    echo $output_text . PHP_EOL;
+}
+
+
+$length = 60;
+
+print_line('=', $length);
+print_line(str_pad('| Welcome to PHP ROUTE TEMPLATE!', $length - 1) . '|');
+print_line('=', $length);
+print_line(str_pad('|-> Author:', 15) . str_pad('Hind Sagar Biswas ', $length - 16, ' ', STR_PAD_LEFT) . '|');
+print_line(str_pad('|-> Github:', 15) . str_pad('https://github.com/hind-sagar-biswas/ ', $length - 16, ' ', STR_PAD_LEFT) . '|');
+print_line('=', $length);
+print_line('');
+
+$consent = strtolower(get_input('Do you want to run setup? [Y/n] ', ''));
+if ($consent == 'no' || $consent == 'n') {
+    exit('Cancelling the setup!');
+}
+echo 'Running the setup...' . PHP_EOL . PHP_EOL;
+
+
+// Take inputs
+$vars = [
+    'APP_NAME' => get_input('App Name', 'PHP Route Template'),
+    'APP_ROOT' => get_input('App root', '/php_route_template'),
+    'APP_URL' => get_input('App URL', 'localhost:8888'),
+    'DATABASE_HOST' => get_input('Database host', 'localhost'),
+    'DATABASE_DATABASE' => get_input('Database database', 'php_route_template'),
+    'DATABASE_USERNAME' => get_input('Database username', 'root'),
+    'DATABASE_PASSWORD' => get_input('Database password'),
+];
+
+// Get template from .env.example
+$file = __DIR__ . "/../.env.example";
+$fp = fopen($file, "r");
+$template = fread($fp, filesize($file));
+fclose($fp);
+
+foreach ($vars as $key => $value) {
+    $template = str_replace("{{{$key}}}", $value, $template);
+}
+
+// Set to .env
+$file = __DIR__ . "/../.env";
+$fp = fopen($file, "w");
+fwrite($fp, $template);
+fclose($fp);
+
+// Set variable values
+
+// Install require packages
+shell_exec('composer install && composer update && npm install');

init.php

@@ -6,10 +6,8 @@
 require_once __DIR__ . '/routes/app.php';
 require_once __DIR__ . '/routes/api.php';
 
-// Loads
+// Load Env Variables
 $dotenv = Dotenv\Dotenv::createImmutable(__DIR__);
-
-// Usage
 $dotenv->safeLoad();
 
 //// CONSTANTS

scripts/classes/logger.class.php

@@ -42,7 +42,7 @@ public function session_login(array $user): bool
      * @param null
      * @return bool
      */
-    public function checkLogin()
+    public function is_logged_in()
     {
         // check the session
         if (isset($_SESSION['username'])) {
@@ -59,7 +59,7 @@ public function checkLogin()
     }
 
 
-    public function remember_me(int $user_id, int $day = 30): void
+    private function remember_me(int $user_id, int $day = 30): void
     {
         [$selector, $validator, $token] = $this->generate_tokens();
 
@@ -77,7 +77,7 @@ public function remember_me(int $user_id, int $day = 30): void
 
     public function logout(): bool
     {
-        if ($this->checkLogin()) {
+        if ($this->is_logged_in()) {
             // delete the user token
             $this->delete_user_token($_SESSION['user_id']);