Ozu Demo Project

This repository is a demonstration project showcasing how to build a static site with dynamic content using the Ozu client for Laravel. Explore the live demo at: https://demo.ozu.code16.fr

---

Table of Contents

• Features
• Prerequisites
• Try Ozu with this project
• Local Development
• Deployment
• Technologies

---

Features

• Dynamic Content powered by Ozu, a content managment platform leveraging our open-source Laravel CMS (Sharp) integrated via the ozu-client package
• 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

   git clone https://github.com/dvlpp/ozu-demo.git
   cd ozu-demo

2. Install PHP dependencies

   composer install

3. Install frontend dependencies

   npm install

4. Environment configuration

   cp .env.example .env
   php artisan key:generate

5. Configure Ozu credentials in your .env:

   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:

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 for more details.

---

Technologies used in this demo project

• Laravel (PHP Framework)
• ozu-client (Ozu integration package)
• Tailwind CSS
• Vite
• Alpine.js