> For the complete documentation index, see [llms.txt](https://hollow-peak.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://hollow-peak.gitbook.io/docs/installation/local-installation.md).

# Local Installation

Running Hollow Peak on your own machine for development.

For evaluating Hollow Peak or developing against it.

## With PHP's built-in server

```bash
cd application
cp .env.example .env
php artisan key:generate
# edit .env for your local database
php artisan hollowpeak:install --demo
php artisan serve
```

Open `http://127.0.0.1:8000`.

## With XAMPP, MAMP or Laragon

Point the site at `application/public` and follow the same steps. Set `APP_URL` to whatever address you use.

## Demo content

`--demo` installs sample departments, staff, clients, projects, tasks, categories and products, so the screens are not empty while you look around.

It is international and generic — invented company names, `example.com` addresses, USD pricing.

To add it later:

```bash
php artisan db:seed --class="Database\Seeders\DemoSeeder"
```

{% hint style="warning" %}
Delete demo content before going live. The sample staff accounts have random passwords nobody knows, but they still appear in your team directory.
{% endhint %}

## Local email

The default `MAIL_MAILER=log` writes messages to `storage/logs/laravel-*.log` instead of sending them. That is usually what you want locally.

To see them rendered, use a catcher such as Mailpit or MailHog and point SMTP at it.

## Rebuilding front-end assets

Only needed if you edit `resources/js` or `resources/css`.

```bash
npm install
npm run dev     # watches for changes
npm run build   # production build
```

Most of the interface is plain CSS and JavaScript in `public/css` and `public/js`, which need no build step at all. Vite handles only the 3D viewer and the code showcase.

## Running the tests

```bash
php artisan test
```

329 tests, using an in-memory SQLite database. They do not touch your development data.

{% hint style="warning" %}
**If almost every test fails, the configuration is cached.**

`php artisan optimize` (or `config:cache`) writes your `.env` into a cached config file, and that cache overrides the testing environment — so the suite tries to run against your **production** database and fails in bulk, usually complaining about an unexpected prompt.

```bash
php artisan config:clear
php artisan test
```

Re-run `php artisan optimize` afterwards if this is a production installation. This is normal Laravel behaviour rather than something specific to Hollow Peak, but it catches people out.
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://hollow-peak.gitbook.io/docs/installation/local-installation.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
