PHPackages                             frostybee/slim-template - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [HTTP & Networking](/categories/http)
4. /
5. frostybee/slim-template

ActiveProject[HTTP & Networking](/categories/http)

frostybee/slim-template
=======================

A Slim framework skeleton for implementing REST-based Web services.

v1.4.4(2mo ago)624MITPHPPHP >=8.2

Since Jun 6Pushed 2mo ago1 watchersCompare

[ Source](https://github.com/frostybee/slim-template)[ Packagist](https://packagist.org/packages/frostybee/slim-template)[ Docs](https://github.com/frostybee/slim-template)[ RSS](/packages/frostybee-slim-template/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependencies (8)Versions (9)Used By (0)

- [Starter Template](#starter-template)
    - [How Do I Use/Deploy this Template?](#how-do-i-usedeploy-this-template)
        - [Option 1: Using Composer (Recommended)](#option-1-using-composer-recommended)
        - [Option 2: Using Docker (macOS/Linux/Windows)](#option-2-using-docker-macoslinuxwindows)
        - [Option 3: Manual Installation](#option-3-manual-installation)
        - [Option 4: Using Nginx (Native Server)](#option-4-using-nginx-native-server)
    - [How Do I Configure My Database Connection?](#how-do-i-configure-my-database-connection)
    - [How do I Use Composer with Wampoon?](#how-do-i-use-composer-with-wampoon)
    - [On Using Environment Variables](#on-using-environment-variables)
    - [Useful VS Code Keybindings](#useful-vs-code-keybindings)

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**](https://www.slimframework.com/).

How Do I Use/Deploy this Template?
----------------------------------

[](#how-do-i-usedeploy-this-template)

### Option 1: Using Composer (Recommended)

[](#option-1-using-composer-recommended)

1. Open a terminal in your web server's **document root** (i.e., `htdocs`).
2. Run the following command: ```
    composer create-project frostybee/slim-template [project-name]-api
    ```

    Replace `[project-name]` with your project name (e.g., `worldcup-api`).
3. Open your `[project-name]-api` folder in VS Code.
4. Adjust your database credentials in `config/env.php` (**see below**).

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

[](#option-2-using-docker-macoslinuxwindows)

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](https://www.docker.com/products/docker-desktop/)
- Install [Git](https://git-scm.com/downloads)

**Quick Start:**

1. 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`).
2. Navigate to the project folder:

    ```
    cd [project-name]-api
    ```
3. Remove the `.git` folder to start fresh with your own repository:

    ```
    rm -rf .git
    ```
4. 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.
5. Access the application:

    - **App:**
    - **phpMyAdmin:**

**Configuring the Database:**

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

1. Update `docker-compose.yml`:

    ```
    db:
      environment:
        MYSQL_DATABASE: your_database_name
    ```
2. Update `config/env.docker.php`:

    ```
    $settings['db']['database'] = 'your_database_name';
    ```
3. Rebuild containers: `docker-compose up -d --build`

**Importing Database Schema:**

To automatically import a database schema when the container starts:

1. Place your `.sql` file(s) in the `docker/init-db/` folder
2. 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):**

UsernamePasswordrootsecretslim\_userslim\_pass**Common Commands:**

ActionCommandStart 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

[](#option-3-manual-installation)

1. Download this repository as a `.zip` file.
2. Extract the downloaded `slim-template-main.zip` file locally.
3. Copy the `slim-template-main` folder into your web server's **document root** (i.e., `htdocs`).
4. Rename the `slim-template-main` folder to `[project_name]-api` (for example, `worldcup-api`).
5. Open your `[project_name]-api` folder in VS Code.
6. 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.
7. In the `config` folder, make a copy of `env.example.php` and rename it to `env.php`.
8. 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`

### Option 4: Using Nginx (Native Server)

[](#option-4-using-nginx-native-server)

If you're running Nginx directly on your server (not through Docker), configuration files are provided in the `nginx/` directory.

**Quick Start:**

1. Deploy your application to your server
2. Copy `nginx/slim-template.conf` to `/etc/nginx/sites-available/your-project-name`
3. Edit the configuration file to match your setup (domain, paths, PHP-FPM socket)
4. Enable the site: ```
    sudo ln -s /etc/nginx/sites-available/your-project-name /etc/nginx/sites-enabled/
    ```
5. Test and reload: ```
    sudo nginx -t && sudo systemctl reload nginx
    ```

**Important Notes:**

- Set document root to the `public/` directory (not the project root)
- Nginx doesn't use `.htaccess` files - all configuration is in the server config
- You need PHP-FPM installed and running

For detailed instructions, see [nginx/README.md](nginx/README.md).

How Do I Configure My Database Connection?
------------------------------------------

[](#how-do-i-configure-my-database-connection)

Follow the outlined instructions in [config/env.example.php](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?
-----------------------------------

[](#how-do-i-use-composer-with-wampoon)

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

ActionCommandDescriptionInstall 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
------------------------------

[](#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](https://github.com/vlucas/phpdotenv/issues/76#issuecomment-87252126)

Just Google: "DB\_PASSWORD" filetype:env Alternatively, you can visit the following link: [Google env search](https://www.google.ch/search?q=%22DB_PASSWORD%22+filetype:env)

Instead, follow the instructions that are detailed in [config/env.example.php](config/env.example.php)

Useful VS Code Keybindings
--------------------------

[](#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": "