personal-security-checklist

<h1 align="center">Personal Security Checklist</h1>

<p align="center">
<b><i>The ultimate list of tips to secure your digital life</i></b>
<br />
<b>🌐 <a href="https://digital-defense.io/">digital-defense.io</a></b><br />
<br />
<a href="https://personal-security-checklist.as93.net"><img src="https://i.ibb.co/Rb6P6h6/shield.png" width="64" /><br /></a>
<br />
<kbd><br />👉 <a href="https://github.com/Lissy93/personal-security-checklist/blob/HEAD/CHECKLIST.md"><b>Read the Checklist</b></a> 👈<br /><br /></kbd>
<br />
</p>

<details>
    <summary><b>Contents</b></summary>
    
- [The Checklist](#the-checklist)
- [The Website](#the-website)
- [The API](#the-api)
- [Contributing](#contributing)
- [Credits](#credits)
- [License](#license)

</details>

---

## The Checklist

You can read the full checklist in [`CHECKLIST.md`](https://github.com/Lissy93/personal-security-checklist/blob/HEAD/CHECKLIST.md).<br>
<sub>To view/edit the raw data, see [`personal-security-checklist.yml`](https://github.com/Lissy93/personal-security-checklist/blob/master/personal-security-checklist.yml)</sub>

---

## The Website

The easiest method for consuming the checklist is via our website: **[digital-defense.io](https://digital-defense.io/)**

Here you can browse lists, filter by your threat model and tick items off once complete (plus, there are pretty charts to make you feel good about your progress ☺️).

<p align="center">
<img width="600" src="https://i.ibb.co/jzKn05H/digital-defense.png" />
</p>

### About
The source for the website is in [`web/`](https://github.com/Lissy93/personal-security-checklist/blob/HEAD/web).<br />
The site is built with Qwik, using TypeScript and some components from DaisyUI.

### Developing
To run the app locally, or to make code changes, you'll need Node (20.19+ or 22.12+) and Git installed.

1. Grab the code: `git clone git@github.com:Lissy93/personal-security-checklist.git`
2. Navigate into the source: `cd personal-security-checklist/web`
3. Install dependencies: `yarn`
4. Start the development server: `yarn dev`

Alternatively, just open this repo in Code Spaces, where everything is already configured and ready to go.

### Deploying

### Option 1) From source
To deploy the app, follow the developing steps above, then run `yarn build.ssg`. You can then deploy it by copying the `dist/` directory to any CDN, web server or static hosting provider of your choice.

### Option 2) Static host
Alternatively, fork the repo and import it into any static hosting provider, like Vercel or Netlify.

### Option 3) Docker
We also have a Docker image published to GHCR and DockerHub ([`lissy93/personal-security-checklist`](hub.docker.com/r/lissy93/personal-security-checklist)).
It's ~11 MB, runs as a non-root user, works on `amd64`, `arm64` and `armv7`, and gets rebuilt whenever the checklist changes, serving the site with nginx on port 8080.

Either see the [`docker-compose.yml`](https://github.com/Lissy93/personal-security-checklist/blob/HEAD/docker/comp