Skip to content

adrijan9/harbor

Repository files navigation

Harbor

Harbor Logo Harbor Logo

Warning: Harbor is under active development and is not production-ready yet.

Microservice-oriented PHP runtime primitives. No MVC ceremony.

What Is Harbor

Harbor is a lightweight PHP runtime/framework toolkit for page-first projects with explicit routing and helper modules.

  • It is not an MVC framework.
  • It does not require controllers.
  • It does not enforce architecture.

Getting Started

Requirement: PHP 8.5 or higher.

  1. Create an empty project directory.
mkdir my-harbor-app
cd my-harbor-app
  1. Initialize Composer.
composer init
  1. Install Harbor.
composer require harbor/harbor

If your environment cannot resolve harbor/harbor from Packagist yet, use a VCS source:

composer config repositories.harbor vcs https://github.com/adrijan991/harbor
composer require harbor/harbor:dev-main
  1. Serve Harbor documentation locally.
./vendor/bin/harbor-docs
  1. Open the printed local URL (for example http://localhost:8080) and continue from the docs site.

Documentation

Harbor documentation is intended to run locally:

./vendor/bin/harbor-docs

Search index is build automatically, but if you like to rebuild it manually (for example, after changing docs content), run: Search index rebuild command (only when docs content changes):

./vendor/bin/harbor-docs-index

Contributing

Contributions are welcome! Please see CONTRIBUTION.md for guidelines on how to contribute to Harbor.

This README is intentionally kept short. Detailed usage and updates continue in the documentation site.

About

Harbor is a minimal multi-project PHP runtime.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages