https://github.com/frostybee/slim-template

A Slim-based application skeleton for implementing REST-based Web services.
https://github.com/frostybee/slim-template

rest-api rest-template slim-4 slim-framework slim-template

Last synced: 14 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/frostybee/slim-template
• Owner: frostybee
• License: mit
• Created: 2023-09-12T01:43:42.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-09-13T00:48:40.000Z (2 months ago)
• Last Synced: 2024-09-13T13:25:05.837Z (2 months ago)
• Topics: rest-api, rest-template, slim-4, slim-framework, slim-template
• Language: PHP
• Homepage:
• Size: 2.32 MB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
- [Starter Template](#starter-template)

  - [How Do I Use/Deploy this Template?](#how-do-i-usedeploy-this-template)

  - [How Do I Configure My Database Connection?](#how-do-i-configure-my-database-connection)

  - [On Using Environment Variables](#on-using-environment-variables)

  - [Adding Fira Code Font to VS Code Portable](#adding-fira-code-font-to-vs-code-portable)

  - [Useful VS Code Keybindings](#useful-vs-code-keybindings)

  - [VS Code Extensions](#vs-code-extensions)

    - [PHP, HTML, and JavaScript](#php-html-and-javascript)

    - [Markdown](#markdown)

    - [Productivity](#productivity)

    - [Appearance](#appearance)

      - [Dark Themes](#dark-themes)

# 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?

Follow the instructions below in the specified order:

1. Download this repository as `.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** (that is, `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. Open a terminal window in VS Code (hit ``` Ctrl+` ```), and run `composer.bat update` command to install or update the required dependencies. Make sure that `Command Prompt` is selected (the dropdown menu in the upper-right corner).

7. 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](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.

## 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 [Google](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)

## Adding Fira Code Font to VS Code Portable

1. Open your VS Code installation folder,

2. Navigate to:

    ```batch 

    resources > app > out > vs >code > electron-sandbox > workbench

    ```

3. Open `workbench.js` in a text editor,

4. Add the following to the end of `workbench.js` then save it,

    ```javascript

    var styleNode = document.createElement('style'); 

    styleNode.type = "text/css"; 

    var styleText = document.createTextNode(`

        @font-face{

            font-family: 'Fira Code';

            src: url('https://raw.githubusercontent.com/tonsky/FiraCode/master/distr/eot/FiraCode-Regular.eot') format('embedded-opentype'),

                url('https://raw.githubusercontent.com/tonsky/FiraCode/master/distr/woff2/FiraCode-Regular.woff2') format('woff2'),

                url('https://raw.githubusercontent.com/tonsky/FiraCode/master/distr/woff/FiraCode-Regular.woff') format('woff'),

                url('https://raw.githubusercontent.com/tonsky/FiraCode/master/distr/ttf/FiraCode-Regular.ttf') format('truetype');

            font-weight: normal;

            font-style: normal;

        }`); 

    styleNode.appendChild(styleText); 

    document.getElementsByTagName('head')[0].appendChild(styleNode);

    ```

5. Open VS Code

6. Open `settings.json` then add the following:

    ```json

    "editor.fontFamily": "Fira Code",

    "editor.fontLigatures": true,

    "editor.fontWeight": "400" // normal

    ```

    

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

```json

 {

    "key": "alt+shift+p",

    "command": "type",

    "args": {

      "text": "=>"

    },

    "when": "textInputFocus"

  },

  {

    "key": "ctrl+shift+j",

    "command": "type",

    "args": {

      "text": "$this->"

    },

    "when": "textInputFocus"

  },

  {

    "key": "ctrl+shift+k",

    "command": "type",

    "args": {

      "text": "->"

    },

    "when": "textInputFocus"

  },

  {

    "key": "ctrl+shift+l",

    "command": "type",

    "args": {

      "text": "