Skip to content

Commit 1f62606

Browse files
committed
Readme
1 parent dec956c commit 1f62606

File tree

1 file changed

+17
-7
lines changed

1 file changed

+17
-7
lines changed

README.md

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ php artisan vendor:publish --tag="ozu-client-config"
2222

2323
### Routes, controllers, views
2424

25-
Create your routes, controllers, views, etc. as you would do for a regular Laravel project — with a few restrictions in mind:
26-
- TODO
25+
Create your routes, controllers, views, etc. as you would do for a regular Laravel project — with a few restrictions in mind, because of the static nature of the project:
26+
- Do not use any querystring
2727
- TODO
2828
- ...
2929

@@ -188,6 +188,10 @@ class DatabaseSeeder extends OzuSeeder
188188
}
189189
```
190190

191+
### Check the demo project for an example
192+
193+
You can refer to the Ozu demo project [dvlpp/ozu-demo](https://github.com/dvlpp/ozu-demo) for an example of a simple project that uses Ozu.
194+
191195
## Go for production
192196

193197
Once your project is ready, you can deploy it to Ozu.
@@ -230,12 +234,18 @@ This command will create a new collection in Ozu for each of your declared Model
230234
At this stage, you should be able to see your custom CMS at the address https://ozu.code16.fr/sharp. Here you can manage the content of your collections.
231235

232236
> [!NOTE]
233-
> For now there is no way to seed production data, but it's in the roadmap.
237+
> Sharp is the underlying content management framework used by Ozu: although you really don’t have to know it to use Ozu, you can [check its website](https://sharp.code16.fr) if you are curious.
238+
239+
> [!NOTE]
240+
> For now there is no way to seed production data, but it’s high in the roadmap.
234241
235242
### Deploy your project
236243

237-
To deploy your project in the actual production space, you'll need a few more steps:
244+
Once you have entered your content in the CMS, you can deploy the project as a static website following these steps:
238245

239-
- attach you Github repository to your Ozu project
240-
- Netlify
241-
- ...
246+
1. install Ozu Github app + grant read only access to your repository
247+
2. configure github repo + branch in Ozu dashboard (configuration menu)
248+
3. Create a new personal access token in Netlify (https://app.netlify.com/user/applications/personal) with expiration set to "No expiration" and report it in Ozu dashboard
249+
4. Create Netlify site in Ozu dashboard
250+
5. (push you latest code in your repo if needed and adapt your content in Ozu CMS)
251+
6. click on "Deploy"!

0 commit comments

Comments
 (0)