https://github.com/mistralys/php-projects-navigator
Overview generator for projects, tools and websites in a local development webserver.
https://github.com/mistralys/php-projects-navigator
Last synced: over 1 year ago
JSON representation
Overview generator for projects, tools and websites in a local development webserver.
- Host: GitHub
- URL: https://github.com/mistralys/php-projects-navigator
- Owner: Mistralys
- License: mit
- Created: 2024-03-24T15:25:20.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-26T17:41:46.000Z (over 2 years ago)
- Last Synced: 2025-01-22T18:14:40.552Z (over 1 year ago)
- Language: PHP
- Size: 369 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PHP Projects Navigator
This lightweight tool is meant to be used as your local webserver's starting page.
It lists all your projects and tools in a simple and clean UI.
## Features
- Find and list all project folders
- Filter the list by search terms
- Detect VCS type (Git, SVN...)
- Link to Composer project homepages
- Display PHP version constraints
- Register tools for quick access in the UI
## Requirements
- Local webserver with PHP support
- PHP 7.4 or higher
- [Composer][]
## Installation
1. Clone this repository to a location on your webserver.
2. Run `composer install` in the project directory.
3. Copy the file `config/projects.json` to `projects.json`.
4. Edit the config file to match your project structure.
5. Open the UI in your browser, e.g. `http://localhost/php-projects-navigator/htdocs/`.
6. (Optional) Set as your webserver's homepage, see [Use as Webserver homepage](#use-as-webserver-homepage).
### Use as Webserver homepage
Because all paths and URLs are absolute, the UI can be used from any subdirectory of the webserver.
1. Create an `index.php` file in the target location.
2. Include the `htdocs/index.php` file of this project there.
Example code:
```php