README

Starter Template

Starter Template

This repository contains an application skeleton for creating REST-based Web services using the latest version of the Slim micro framework.

How Do I Use/Deploy this Template?

Option 1: Using Composer (Recommended)

Open a terminal in your web server's document root (i.e., htdocs).
Run the following command:
```
composer create-project frostybee/slim-template [project-name]-api
```
Replace [project-name] with your project name (e.g., worldcup-api).
Open your [project-name]-api folder in VS Code.
Adjust your database credentials in config/env.php (see below).

Option 2: Using Docker (macOS/Linux/Windows)

Docker allows you to run the application in containers without installing PHP, Apache, or MariaDB locally. This works on macOS, Linux, and Windows.

Prerequisites:

Install Docker Desktop
Install Git

Quick Start:

Clone the repository (since Composer requires PHP, which you may not have installed):
```
git clone https://github.com/frostybee/slim-template.git [project-name]-api
```
Replace [project-name] with your project name (e.g., worldcup-api).
Navigate to the project folder:
```
cd [project-name]-api
```
Remove the .git folder to start fresh with your own repository:
```
rm -rf .git
```
Start all containers by executing the following command:
```
docker-compose up -d
```
Note: Use docker-compose up -d --build to rebuild images after modifying the Dockerfile or related configurations.
Access the application:
- App: http://localhost:8080
- phpMyAdmin: http://localhost:8081

Configuring the Database:

The default database name is slim_app. To use a different database name:

Update docker-compose.yml:

db:
  environment:
    MYSQL_DATABASE: your_database_name

Update config/env.docker.php:

$settings['db']['database'] = 'your_database_name';

Rebuild containers: docker-compose up -d --build

Importing Database Schema:

To automatically import a database schema when the container starts:

Place your .sql file(s) in the docker/init-db/ folder
Start the containers: docker-compose up -d

The SQL files will be executed automatically on first container creation. If you have multiple files, they run in alphabetical order (e.g., 01-schema.sql, 02-data.sql).

To re-import the schema, remove the database volume and restart:

docker-compose down -v
docker-compose up -d

Database Credentials (for phpMyAdmin):

Username	Password
root	secret
slim_user	slim_pass

Common Commands:

Action	Command
Start containers	`docker-compose up -d`
Stop containers	`docker-compose down`
View app logs	`docker-compose logs -f app`
Delete database	`docker-compose down -v`
Rebuild containers	`docker-compose up -d --build`

Working with Multiple Projects:

If you run one project at a time, no configuration changes are needed. Simply stop one project before starting another:

# Stop current project
docker-compose down

# Switch to another project
cd ../other-project
docker-compose up -d

If you need to run multiple projects simultaneously, change the port numbers in docker-compose.yml to avoid conflicts:

services:
  app:
    ports:
      - "8082:80"      # Change 8080 to 8082, 8083, etc.
  db:
    ports:
      - "3307:3306"    # Change 3306 to 3307, 3308, etc.
  phpmyadmin:
    ports:
      - "8083:80"      # Change 8081 to 8083, 8084, etc.

Option 3: Manual Installation

Download this repository as a .zip file.
Extract the downloaded slim-template-main.zip file locally.
Copy the slim-template-main folder into your web server's document root (i.e., htdocs).
Rename the slim-template-main folder to [project_name]-api (for example, worldcup-api).
Open your [project_name]-api folder in VS Code.
Install the project dependencies by running composer. If you are using Wampoon, open a terminal window in VS Code (hit Ctrl+`) then run .\composer.bat update
- If you are not using Wampoon to develop your app, just run composer from the command line.
In the config folder, make a copy of env.example.php and rename it to env.php.
Adjust your database credentials (see below).

NOTE: You can always clone this repository. However, if you do, you need to remove the .git hidden directory before you copy this template over to htdocs

How Do I Configure My Database Connection?

Follow the outlined instructions in config/env.example.php

Change the value of the database variable to reflect the name of the database to be used by your slim app.
You may also want to change the connection credentials in that file.

How do I Use Composer with Wampoon?

To install or update your project dependencies deployed on Wampoon, use the composer.bat script as follows:

Action	Command	Description
Install dependencies	`.\composer.bat install`	Installs packages listed in `composer.json` and creates the `vendor` directory.
Update dependencies	`.\composer.bat update`	Refreshes all packages to the latest versions allowed by `composer.json`.
Add a package	`.\composer.bat require [package]`	Installs a new package and adds it to `composer.json`.
Regenerate autoloader	`.\composer.bat dump-autoload -o`	Rebuilds the optimized autoloader after adding or removing classes.

On Using Environment Variables

Sensitive information used in app such as your database credentials, API key, etc. MUST not be pushed into your Git repo.

Do not use .env files for storing environment specific application settings/configurations. Dotenv is not meant to be used in production

Just Google: "DB_PASSWORD" filetype:env Alternatively, you can visit the following link: Google env search

Instead, follow the instructions that are detailed in config/env.example.php

Useful VS Code Keybindings

Below are keybindings that speeds up the insertion of special characters and keywords while editing a .php file. These bindings need to be added to your VS Code's keybindings.json

  {
    "key": "alt+shift+p",
    "command": "type",
    "args": {
      "text": "=>"
    },
    "when": "textInputFocus && editorLangId == php"
  },
  {
    "key": "ctrl+shift+j",
    "command": "type",
    "args": {
      "text": "$this->"
    },
    "when": "textInputFocus && editorLangId == php"
  },
  {
    "key": "ctrl+shift+k",
    "command": "type",
    "args": {
      "text": "->"
    },
    "when": "textInputFocus && editorLangId == php"
  },
  {
    "key": "ctrl+shift+l",
    "command": "type",
    "args": {
      "text": "<?php"
    },
    "when": "textInputFocus && editorLangId == php"
  },
  {
    "key": "shift+enter",
    "command": "type",
    "args": {
      "text": "$"
    },
    "when": "textInputFocus && editorLangId == php"
  },
  {
    "key": "shift+space",
    "command": "type",
    "args": {
      "text": "_"
    },
    "when": "textInputFocus && editorLangId == php"
  }

frostybee / slim-template

Maintainers

Details