personal-security-checklist README

The project's README from github.com/lissy93/personal-security-checklist. As one markdown file: README.md.

Personal Security Checklist

The ultimate list of tips to secure your digital life
🌐 digital-defense.io




👉 Read the Checklist 👈


Contents

The Checklist

You can read the full checklist in CHECKLIST.md.
To view/edit the raw data, see personal-security-checklist.yml


The Website

The easiest method for consuming the checklist is via our website: 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 ☺️).

About

The source for the website is in web/.
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 [email protected]: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

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.

Alternatively, fork the repo and import it into your providers' dashboard. Or use the link below for an easy 1-click deployment 😉


The API

We also make all the data available via a free API, which you can use however you wish.

Usage

All endpoints are documented in our OpenAPI spec, you can view these and try them out via our Swagger docs.

Base: digital-defense.io/api

/api/checklists /api/checklists/[name-or-index] /api/checklists/[name]/[point-index] /api/search/[searchterm]

Contributing

All checklist data is stored in personal-security-checklist.yml. This is pulled in the website at build-time and referenced by the API, and is also dynamically inserted into the markdown Checklist page.

So if you only wish to make changes to the data, this is the only file you need to edit.

Important: When submitting your pull request, provide references backing up any information that you're adding/amending/removing.

For modifying the website or API source, see the developing sections above for instructions on running locally.

Before submitting an issue or PR, please ensure you've followed the community guidelines and followed the Code of Conduct.


Credits

Sponsors

sponsors badge

Contributors

contributors badge

Stargzers

stargazers badge

Credits

Thank you to all who have contributed to, or sponsored this project!

Sponsors

If you've found this repository helpful, consider sponsoring me on GitHub if you're able 💜

Contributors


License

Lissy93/Personal-Security-Checklist is licensed under MIT © Alicia Sykes 2024.
For information, see TLDR Legal > MIT

Expand License
The MIT License (MIT)
Copyright (c) Alicia Sykes <[email protected]> 

Permission is hereby granted, free of charge, to any person obtaining a copy 
of this software and associated documentation files (the "Software"), to deal 
in the Software without restriction, including without limitation the rights 
to use, copy, modify, merge, publish, distribute, sub-license, and/or sell 
copies of the Software, and to permit persons to whom the Software is furnished 
to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included install 
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANT ABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NON INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

© Alicia Sykes 2024
Licensed under MIT

Thanks for visiting :)

personal-security-checklist (lissy93/personal-security-checklist)

Searching Database…

这是什么?一份由社区维护的清单,包含 300 多条保护数字安全和隐私的实用建议,由 Alicia Sykes(Lissy93)整理,并持续更新至 2026 年。
它只是一份静态文档,还是不止于此?不止于此:每条建议都存放在一个 YAML 文件(personal-security-checklist.yml)中,这个文件可以生成 Markdown 版清单、一个可筛选的网站,以及一个免费的公开 API。
我可以把这份清单或代码用在自己的项目里吗?可以——这个仓库采用 MIT 许可证(© Alicia Sykes 2024),只要注明出处,清单数据和网站代码都可以自由复用。
这个网站是用什么做的?基于 Qwik 和 TypeScript,并使用了一些 DaisyUI 组件;源码在 web/ 文件夹里,仓库中还附带了一个 Dockerfile。
不看网站也能阅读这份清单吗?可以——完整清单就在仓库的 CHECKLIST.md 里,原始数据存放在 personal-security-checklist.yml,方便你复用或修改。
这份清单和 API 收费吗?不收费——清单、网站和 API 全部免费,README 中也欢迎你随意使用这个 API。
有没有不用在本地搭建环境就能参与开发的办法?有——在 GitHub Codespaces 中打开这个仓库就行,那里的一切都已配置好,开箱即用。
Creator
lissy93
Size
90.1 MB
Stars
22.6K
Updated
CommitOct 15
Age
8y
Commits · 90 Days