Getting started
How to put your own copy of Project Broadsheet on your computer and see it running.
Before you begin
- Node.js 18 or later (nodejs.org) — this is the tool that turns the source files into a website
- A free GitHub account (github.com) — this is where your site's source lives online
- A terminal — any Mac, Linux, or Windows machine has one
Download a copy
Pick any folder name that fits your project.
git clone https://github.com/jonajinga/broadsheet.git my-publication cd my-publicationInstall what it needs
npm installTakes under a minute on a modern connection.
Open it in your browser
npm startThe site is now running at
http://localhost:8080. Open it, click around, try the reading tools, see how it feels. Any change you save to a file shows up in the browser within about a second.
You can set things up entirely through a browser. Make a copy of the project on GitHub, connect it to a free host like Cloudflare Pages, and use the built-in browser editor to write. No command line needed. Here's the walk-through.
Next
Set the name and details
Open one file and replace the placeholder name, description, and email with your own.
Change how it looks
Every colour and font is a single line in one file. Change one, the whole site follows.
Add your first article
Create a new file, write a heading and a few paragraphs, save. That's the whole writing workflow.
Put it online
Connect your project to a free host. Your site gets an address, a secure padlock, and updates itself whenever you save a change.
If you'd rather have someone do the setup for you, you can hire me by the hour — details here, or get in touch.