{"id":20603062,"url":"https://github.com/flightphp/skeleton-simple","last_synced_at":"2025-04-15T01:54:49.722Z","repository":{"id":229344624,"uuid":"776507153","full_name":"flightphp/skeleton-simple","owner":"flightphp","description":"This is a skeleton project for a single file application to help your RESTful APIs take Flight!","archived":false,"fork":false,"pushed_at":"2024-10-23T23:41:17.000Z","size":36,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-10-24T13:15:34.104Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/flightphp.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-03-23T17:44:47.000Z","updated_at":"2024-10-24T04:34:25.000Z","dependencies_parsed_at":"2024-03-23T18:20:08.585Z","dependency_job_id":"a654decf-759e-43c7-a30e-4826401b6838","html_url":"https://github.com/flightphp/skeleton-simple","commit_stats":null,"previous_names":["flightphp/skeleton-simple"],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flightphp%2Fskeleton-simple","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flightphp%2Fskeleton-simple/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flightphp%2Fskeleton-simple/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flightphp%2Fskeleton-simple/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/flightphp","download_url":"https://codeload.github.com/flightphp/skeleton-simple/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248991540,"owners_count":21194894,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-16T09:15:52.740Z","updated_at":"2025-04-15T01:54:49.706Z","avatar_url":"https://github.com/flightphp.png","language":"PHP","readme":"# Flight PHP Skeleton App Simple Version\n\nUse 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.\n\nThis 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.\n\n## Installation\n\nRun this command from the directory in which you want to install your new Flight PHP application. (this will require PHP 7.4 or newer)\n\n```bash\ncomposer create-project flightphp/skeleton-simple cool-project-name\n```\n\nReplace `cool-project-name` with the desired directory name for your new application.\n\n**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.\n\n### Simple Setup of the Application\n\nThis 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.\n\nWith the simple setup, there is two very import security steps to be aware of. \n- **DO NOT SAVE SENSITIVE CREDENTIALS TO THE `index.php` FILE**. \n- **DO NOT COMMIT ANY TYPE OF SENSITIVE CREDENTIALS TO YOUR REPOSITORY**.\n\nThis 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.\n\n### More Complex Application\n\nIf you want to build a more complex application, go to the [flightphp/skeleton](https://github.com/flightphp/skeleton) project for a more robust setup.\n\n## Running the Application\n\n### No Dependency Setup\n\nTo run the application in development, you can run these commands \n\n```bash\ncd cool-project-name\ncomposer start\n```\n\nAfter that, open `http://localhost:8000` in your browser.\n\n__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.__\n\n### Docker Setup\n\nYou 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:\n```bash\ncd cool-project-name\ndocker-compose up -d\n# or if a newer version of docker\ndocker compose up -d\n```\nAfter that, open `http://localhost:8000` in your browser.\n\n### Vagrant Setup\nYou 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)\n\n```bash\ncd cool-project-name\nvagrant up\n```\n\nAfter that, open `http://localhost:8000` in your browser.\n\n## Do it!\nThat's it! Go build something flipping sweet!\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflightphp%2Fskeleton-simple","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fflightphp%2Fskeleton-simple","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflightphp%2Fskeleton-simple/lists"}