Using VSCode DevContainers

November 28, 2024About 2 min

Using VSCode DevContainers

The best way to get started with Hazaar is to use the Visual Studio Code devContainers extension. This will automatically setup a development environment for you with all the required dependencies installed and ready to go.

The Hazaar example application is already setup to use devContainers so you can get started quickly. It includes a Dockerfile and a .devcontainer directory that contains the configuration for the development container. It is based on the FrankenPHP image which includes a web server that can be used for both development and production environments.

Tips

For more information on FrankenPHP and how Hazaar supports it, see the FrankenPHP documentation.

Install Dependencies

You will need to have the following installed on your system:

The Example Application

Grab the example application using Git directly:

$ git clone https://git.hazaar.io/hazaar/hazaar myapp

Which will output something like:

Cloning into 'myapp'...
warning: redirecting to https://git.hazaar.io/hazaar/hazaar.git/
remote: Enumerating objects: 552, done.
remote: Counting objects: 100% (293/293), done.
remote: Compressing objects: 100% (244/244), done.
remote: Total 552 (delta 150), reused 23 (delta 23), pack-reused 259 (from 1)
Receiving objects: 100% (552/552), 6.89 MiB | 8.49 MiB/s, done.
Resolving deltas: 100% (254/254), done.

This will create a new directory called myapp in your current working directory. This directory will contain the application and public directories of your project and some example code to help get you started quickly.

Open the project folder in Visual Studio Code and the devcontainers extension will prompt you to open the project in a container. Click the Reopen in Container button to open the project in a container.

This will automatically build and start the container, install all the required dependencies and run a web server for you to access the application. This process can take a minute or two depending on your computer and internet connection.

Warning

Once the container is running you will see that the web server is running, however the application is not yet functional.

You will need to install the composer dependencies. VSCode will prompt you to do this automatically. Click the Install button to install the composer dependencies.

Optionally you can open a terminal in the container and run the composer install command manually:

$ composer install

Once the composer dependencies are installed your application is ready to go. Open your browser and navigate to http://localhost:8000 to see the example application running.

What's Next?

Configuration - Learn how to configure your application.
Routing - Learn how routing works for your application.
Controllers - Learn how to create controllers for your application.
Views - Learn how to create views for your application.
Models - Learn how to create models for your application.
Database - Learn how to use databases in your application.