Skip to content

quickstart.md

Latest commit

 

History

History
74 lines (46 loc) · 2.16 KB

quickstart.md

File metadata and controls

74 lines (46 loc) · 2.16 KB
Raw

Quickstart

This quickstart is for developers who want to get the Quantum PHP Framework running quickly and understand the basic flow before diving deeper into the documentation.

Before you begin

Make sure you have completed the Installation guide first.

1. Create a new project

Create a new project using Composer:

composer create-project quantum/project my-project

The current starter project also runs its post-create setup automatically. On a normal successful install, that setup:

  • creates .env
  • generates APP_KEY
  • installs the demo Web and Api modules
  • installs OpenAPI assets/routes for the Api module
  • publishes DebugBar assets

Then move into the project directory:

cd my-project

2. Start the development server

Run the built-in development command:

php qt serve

If everything is working correctly, the application should now be available in your browser at the local address shown by the command output.

3. Confirm the application is working

Open the local project URL in your browser.

If the installation was successful, you should see the starter demo application.

4. Understand the goal of this first run

At this point, the important thing is not to learn every framework feature at once.

The goal is simply to confirm three things:

  • the framework is installed correctly
  • the CLI tooling is working
  • the starter project bootstrap steps completed successfully
  • the project can run locally in a normal development workflow

5. Learn how the project is organized

Once the project is running, the next step is understanding where the main parts of the application live.

Continue with Project Structure to get a clear overview of how a Quantum PHP Framework project is organized.

6. Suggested next steps

A good next path after this page is:

  1. Project Structure
  2. Routing
  3. Controllers
  4. Views
  5. Modules

This order helps you move from "the app runs" to "I understand how the framework is put together."