personal-security-checklist/.github/README.md
2024-02-10 23:08:09 +00:00

31 KiB

Personal Security Checklist

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




👉 Read the Checklist 👈


Contents


The Checklist

You can view the full checklist in CHECKLIST.md


The Website

The easiest method for consuming the checklist is via our website, at: digital-defense.io

Here you can browse all checklists, filter by level, and check items off as you complete them.

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 and Git installed.

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

Alternatively, just open this repo is 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. You can then deploy it by copying the dist/ directory to any CDN, web server or static hosting provider.

Alternatively, you can deploy to Netlify or Vercel simply by forking the repository, and then importing it via your dashboard. Or use the links below for an easy 1-click deploy.


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]

Developing

Deploying


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.

Prior to submitting an issue or PR, please ensure you've followed the community guidelines laid out in the Code of Conduct.


Credits

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

Sponsors

koconder
Vincent Koc
peng1can
peng1can
alydemah
Aly Mohamed
tbjers
Torgny Bjers
emlazzarin
Eddy Lazzarin
AnandChowdhary
Anand Chowdhary
shrippen
shrippen
davidpaulyoung
David Young
bile0026
Zach Biles
UlisesGascon
Ulises Gascón
digitalarche
Digital Archeology
bmcgonag
Brian McGonagill
vlad-timofeev
Vlad
helixzz
HeliXZz
forwardemail
Forward Email - Open-source & Privacy-focused Email Service (2023)
Bastii717
Bastii717
ratty222
Brent
Glydeon
Byron
NixyJuppie
Nixy
nrvo
nrvo

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

Contributors

Lissy93
Alicia Sykes
liss-bot
Alicia Bot
matkoniecz
Mateusz Konieczny
lucadidomenico
Luca Di Domenico
gitetsu
gitetsu
aarontorres0
Aaron
0xnbk
Nbk
alxndrv
Andrey Aleksandrov
hypogram
hypogram
b3pio
₿ӠⱣłØ
rusty-snake
rusty-snake
marjamis
marjamis
ansuz
Ansuz
zacharyraber
Zachary Raber
sirodoht
Theodore Keloglou
ilesinge
Alexandre G.-Raymond
ba32107
Balazs Gyurak
dmbaturin
Daniil Baturin
mwleeds
Phaedrus Leeds
pndyjack
pndyjack
kdenhartog
Kyle Den Hartog
lukecarr
Luke Carr
lordpansar
Magnus Sundström
mschwrdtnr
Max S.
nickali
Nick Ali
Oymate
Oymate
pdelfino
Pedro Delfino
sjamaan
Peter Bex
yaxollum
Peter Ye
rorymbyrne
Rory Byrne
Silvhr
Silvhr
spikecodes
Spike O'Carroll
ThomasRettig
Thomas Rettig
tim-v3
Tim Weber
zeusalmighty717
Zeus Almighty
apraile
apraile
elesiuta
Eric Lesiuta
fireneat
fireneat
ignoramous
ignoramous
kevodwyer
kevodwyer
notthewave
Axel
ogoregen
Oğuzhan
omahs
Omahs
pabloscloud
pabloscloud
partoneoftwo
partoneoftwo
pipboy96
pipboy96
theblackmallard
theblackmallard
titanism
titanism
0x192
W1nst0n
101lols
101lols
boushley
Aaron Boushley
Adv4n6
Adv4n6
ndsvw
Alex
andydonzelli
Andy Donzelli
austinhuang0131
Austin Huang
ben-thul
Ben Thul
BBlackwo
Benjamin B
BrunoBernardino
Bruno Bernardino
chemmi
Christian Hemminghaus
DaShoe
DaShoe
danielgtaylor
Daniel G. Taylor
dim1119
Dimitris Lazarakis
VoDmAl
Dmitry Vorobyev
federicoviceconti
Federico
0x5FE
0x5FE
fkohrt
Florian Kohrt
freddy-m
Freddy
hw4n
Hwanhee Chae
jneplokh
Jacob Neplokh
gongjason
Jason G
mxygem
Gemini Smith
monkeywithacupcake
Jess
openjck
John Karahalis
edelbluth
Juergen Edelbluth
fetzu
Julien
seclution
Kai Biebel
koirand
Kazuki Koide
Kotbenek
Dominik Piątkowski
leon-costa
Leon Costa

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 <alicia@omg.com> 

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 :)