https://github.com/flightphp/skeleton-simple
This is a skeleton project for a single file application to help your RESTful APIs take Flight!
https://github.com/flightphp/skeleton-simple
Last synced: 9 months ago
JSON representation
This is a skeleton project for a single file application to help your RESTful APIs take Flight!
- Host: GitHub
- URL: https://github.com/flightphp/skeleton-simple
- Owner: flightphp
- Created: 2024-03-23T17:44:47.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-10-23T23:41:17.000Z (over 1 year ago)
- Last Synced: 2024-10-24T13:15:34.104Z (over 1 year ago)
- Language: PHP
- Size: 35.2 KB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Flight PHP Skeleton App Simple Version
Use this skeleton application to quickly setup and start working on a new Flight PHP application. This application uses the latest version of Flight PHP v3.
This skeleton application was built for Composer. You also could download a zip of this repo, downloading a zip of the [flightphp/core](https://github.com/flightphp/core) repo, and manually autoload the files by running `require('flight/autoload.php')` in your `app/config/bootstrap.php` file.
## Installation
Run this command from the directory in which you want to install your new Flight PHP application. (this will require PHP 7.4 or newer)
```bash
composer create-project flightphp/skeleton-simple cool-project-name
```
Replace `cool-project-name` with the desired directory name for your new application.
**Note:** If you are installing with PHP 8.0 or above and want to use `tracy-extensions` be sure to run `composer require --dev flightphp/tracy-extensions "^0.2"` after the project is created.
### Simple Setup of the Application
This is basically a single file application. The only exception to this is the config file which is still in the `app/config/` directory. This is a good starting point for smaller projects or projects that you don't anticipate will grow much.
With the simple setup, there is two very import security steps to be aware of.
- **DO NOT SAVE SENSITIVE CREDENTIALS TO THE `index.php` FILE**.
- **DO NOT COMMIT ANY TYPE OF SENSITIVE CREDENTIALS TO YOUR REPOSITORY**.
This is what the config file is for. If you need to save sensitive credentials (API keys, database credentials, etc), save them to the config file and then reference them in the `index.php` file.
### More Complex Application
If you want to build a more complex application, go to the [flightphp/skeleton](https://github.com/flightphp/skeleton) project for a more robust setup.
## Running the Application
### No Dependency Setup
To run the application in development, you can run these commands
```bash
cd cool-project-name
composer start
```
After that, open `http://localhost:8000` in your browser.
__Note: If you run into an error similar to this `Failed to listen on localhost:8000 (reason: Address already in use)` then you'll need to change the port that the application is running on. You can do this by editing the `composer.json` file and changing the port in the `scripts.start` key.__
### Docker Setup
You can [install Docker](https://docs.docker.com/engine/install/) and use `docker-compose` to run the app with `docker`, so you can run these commands:
```bash
cd cool-project-name
docker-compose up -d
# or if a newer version of docker
docker compose up -d
```
After that, open `http://localhost:8000` in your browser.
### Vagrant Setup
You can [install Vagrant](https://vagrantup.com/download) and a provider like [VirtualBox](https://www.virtualbox.org/wiki/Downloads) and use simple run the following command to bring up an environment with PHP/MariaDB already setup based on [n0nag0n/firefly](https://github.com/n0nag0n/firefly)
```bash
cd cool-project-name
vagrant up
```
After that, open `http://localhost:8000` in your browser.
## Do it!
That's it! Go build something flipping sweet!