Getting Started

November 8, 2024About 1 min

Getting Started

Caution

This page is tagged as a draft and is a work in progress. It is not yet complete and may contain errors or inaccuracies.

Caution

We are committed to the principle of release early, release often. As a result, this documentation is a work in progress. The original Hazaar documentation served primarily as an internal reference, containing a collection of assorted information. Consequently, some sections may seem incomplete or unclear without prior knowledge.

Additionally, some links may be broken as we continue to update and reorganize the content.

Rest assured, we are actively working on organizing and rewriting the documentation to better serve your needs. Thank you for your patience as we improve the documentation for the latest version of Hazaar.

Installation

Pre-requisites

Tips

For help with setting up Visual Studio Code for Hazaar development, see Tooling.

To get started with Hazaar, you need to create an application using composer. This is a simple process that will create a new directory containing your application and all the required dependencies.

The Example Application

$ composer create-project hazaar/hazaar myapp

Alternatively you can get the example application using Git directly:

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

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. If installed with composer, the library will also be installed in the vendor directory.

Once you have the example application, you can open it in Visual Studio Code. If you have the devcontainers extension installed, you will be prompted to open the project in a container. This will automatically start the container and install all the required dependencies.

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.