← home-pi

Project space

Welcome, Denzel.

This is your corner of the server. Everything under /projects/hurricane/ is yours to build. You are the only other person working in here, so you will not be stepping on anyone's toes.

Where your stuff goes

apps/public-web/site/projects/hurricane/ ├── index.html this page, your landing page ├── assets/ │ ├── css/ your stylesheets │ ├── js/ your JavaScript │ └── img/ images, icons, media │ ├── your-first-project/ │ ├── index.html lives at /projects/hurricane/your-first-project/ │ └── assets/ keep each project's files with the project │ └── another-project/ ├── index.html └── assets/

New projects

Make a new folder inside hurricane/, drop an index.html in it, and it goes live at /projects/hurricane/your-folder-name/. No config to edit, no route to register. Folder name becomes the URL.

Use lowercase and hyphens for folder names: storm-tracker, not Storm Tracker.

JavaScript

Shared scripts you use across projects go in /projects/hurricane/assets/js/. Script that only one project needs goes in that project's own assets/js/ folder.

Link it with an absolute path so it works from any page:
<script src="/projects/hurricane/assets/js/yourfile.js"></script>

CSS and assets

Same idea. Shared styles in /projects/hurricane/assets/css/, images in /projects/hurricane/assets/img/. Project-specific files stay inside that project's folder.

There is no site-wide stylesheet you have to inherit from. The root site has its own and it is not yours to worry about. Style Hurricane however you want.

How it gets live

You do not upload anything to the Pi. The flow is:

  1. Add or edit files in the repo
  2. Push to main
  3. CI checks it. If CI fails, nothing deploys
  4. The Pi pulls the approved commit automatically, within about five minutes

If your page is not showing up, wait a few minutes and hard-refresh before assuming it is broken.

House rules

Stay inside hurricane/. Everything you need is in here. Files outside this folder run the rest of the platform.
File types are allow-listed. HTML, CSS, JS, images, fonts, video and JSON all work. Anything else returns a 404 rather than downloading.
Nothing secret goes in here. This folder is on the public internet. No passwords, no API keys, no personal details. If you would not put it on a billboard, it does not go in a file here.
Every folder needs an index.html. There are no directory listings, so a folder without one is just a 404.