https://github.com/code16/ozu-demo
https://github.com/code16/ozu-demo
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/code16/ozu-demo
- Owner: code16
- Created: 2024-02-06T17:49:14.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2026-01-23T12:56:10.000Z (2 months ago)
- Last Synced: 2026-01-24T03:53:39.424Z (2 months ago)
- Language: PHP
- Size: 1.37 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Ozu Demo Project
This repository is a demonstration project showcasing how to build a static site with dynamic content using the [Ozu client](https://github.com/code16/ozu-client) for Laravel. Explore the live demo at: [https://demo.ozu.code16.fr](https://demo.ozu.code16.fr)
---
## Table of Contents
* [Features](#features)
* [Prerequisites](#prerequisites)
* [Try Ozu with this project](#try-ozu-with-this-project)
* [Local Development](#local-development)
* [Deployment](#deployment)
* [Technologies](#technologies-used-in-this-demo-project)
---
## Features
* **Dynamic Content** powered by Ozu, a content managment platform leveraging our open-source Laravel CMS ([Sharp](https://github.com/code16/sharp)) integrated via the [ozu-client package](https://github.com/code16/ozu-client)
* **Static Site Generation** is **fully handled** by Ozu for fast, secure, and cache-friendly delivery
* **Come as you are**: use your back and frontend stacks to develop static
---
## Prerequisites
* PHP 8.3+
* An Ozu account (beta access, feel free to contact us, we're looking for beta testers)
---
## Try Ozu with this project
1. **Clone the repository**
```bash
git clone https://github.com/dvlpp/ozu-demo.git
cd ozu-demo
```
2. **Install PHP dependencies**
```bash
composer install
```
3. **Install frontend dependencies**
```bash
npm install
```
4. **Environment configuration**
```bash
cp .env.example .env
php artisan key:generate
```
5. **Configure Ozu credentials** in your `.env`:
```dotenv
OZU_API_KEY=your_api_key
OZU_WEBSITE_KEY=your_website_key
OZU_API_HOST=https://ozu.code16.fr/
```
---
## Local Development
Run the built-in server for frontend development:
```bash
composer run dev
```
---
## Deployment
1. **Connect your GitHub repo** via the Ozu dashboard.
2. **Install the Ozu GitHub App** and grant read-only access.
3. **Provision a Netlify site** or your own VPS via an SSH access.
4. **Add content to your website** from Ozu's CMS.
5. **Trigger a deploy** from the Ozu dashboard.
> See [Ozu](https://ozu.code16.fr) for more details.
---
## Technologies used in this demo project
* **Laravel** (PHP Framework)
* **[ozu-client](https://github.com/code16/ozu-client)** (Ozu integration package)
* **Tailwind CSS**
* **Vite**
* **Alpine.js**