dtgm / prism-break

Privacy-aware alternatives to proprietary software.

prism-break

Contributors are welcome.

30-Second Quick Start

1. Edit

vi ./source/db/en-projects.json                  # edit or add a project

cp project.png ./source/assets/images/medium/    # put 60x60 PNG here

2. Test

npm install
make test      # builds ./public/en for preview purposes

3. Translate

# set up stubs by copying your edits to *-projects.json
./source/db/*-projects.json

At this point, feel free to commit the changes and submit a pull request. Steps #4 and #5 are only necessary if you want to build your own copy of the site.

4. Build

make all       # get a drink, it'll take a while build all 27 languages

make reset     # making a drastic change? run this instead of `make all`
               # this will vaporize /public before running `make all`

5. Serve

Serve the folder ./public on your web server.

Project Inclusion Guidelines

Only F/OSS software is allowed to be featured on PRISM Break. The only exception is when free software offers no viable alternative to proprietary software. "Web Search" is the only category with this exception currently.

Quality over quantity. PRISM Break strives to promote the best open source applications. Ease of use, stability, and performance matter. This is the first time many people are looking to leave their proprietary walled gardens. Let's make it a good experience for them. If you're writing a privacy-minded FOSS app, please finish it before asking PRISM Break to promote it.

Before suggesting software, please first search this repository to see if your request has already been made. If it has been rejected, you'll learn why. If the issue hasn't been addressed, add a comment as to why it deserves inclusion. If the software has been improved significantly since the initial rejection, feel free to suggest it again.

Pull requests are prioritized over issues. I will respond to them quicker and they will get an answer faster.

Contribute: Projects

Which Files to Edit

If you want to edit or add a project to PRISM Break, this data resides here:

./source/db/*-projects.json

If you want to edit or add to the project logos on this site, look here:

./source/assets/images/medium/          # for images currently used
./source/assets/images/original/        # for high res/svg versions

Add the Project Data

Append the sample project to the file ./source/db/en-projects.json. Edit the values to fit your project. Repeat the process for the other languages (e.g. ./source/db/de-projects.json).

Sample Project:

* name: "Awesome Project"
  logo: "awesome-project.png"
  description: "A 3-4 sentence description of the project goes here."
  notes: "Note that the project is in beta, has not been audited, etc."
  url: "https://www.awesome-project.org"
  wikipedia_url: "https://en.wikipedia.org/wiki/Awesome_Project"
  privacy_url: ""
  tos_url: ""
  license_url: "https://git.awesome-project.org//master/LICENSE.txt"
  source_url: "https://git.awesome-project.org/master/"
  protocols: ["GPG", "OTR", "XMPP"]
  categories: [
    * name: "Web Services"
      subcategories: ["Email Accounts", "Social Networks"]
    * name: "Linux"
      subcategories: ["Operating Systems"]
    * name: "Mac OS X"
      subcategories: ["Instant Messaging", "IRC"]
    * name: "Windows"
      subcategories: ["Disk Encryption", "VPN Clients"]
  ]

Only the fields name, description, logo, url, and categories are required. The other fields can be left empty with a value of "" ([] for protocols).

Add the Project Thumbnail

Project thumbnails should be in the PNG format. Try to get a 1024px x 1024px (or better) version of the logo for ./source/images/original and rescale it to 60x60 and 120x120 for ./source/images/medium and ./source/images/medium@2x

Testing Your Edits/Additions

When you're done with your edits, you should build the site to see if it compiles properly. To do so, run:

make test

Which will generate:

./public/en/

It might take a little while (~minutes) if you're on a slower computer.

Publishing Your Changes

Visit ./public/en/ in your browser and check out your work. If it looks good, commit the changes and issue a pull request. Thanks for your contribution!

Contribute: Localizations

Which Files to Edit

If you want to translate project descriptions, URLs, or notes into your favorite language, this data resides in:

./source/db/*-projects.json

If you're interested in translating the site itself (all the nouns, verbs, and sentences that make up the static portion of the site), look here:

./source/locales/*.json

If your language file doesn't exist yet, you can copy the en.json file and start translating from there.

JSON Validation

Make sure your JSON validates by using either JSONLint or your own validator. A common mistake is putting unescaped quotation marks in a sentence. Make sure to escape them with either HTML entities (curly quotes) or a backslash (straight quotes).

"description": "Use curly quotes “like this”.",

"description": "Escape straight quotes \"like this\".",

"description": "Not escaping quotes will cause "an error".",

Testing Your Translation

When you're done with your translation, you should build the site in your language and see if it works. To do so, you'll have to temporarily edit the ./Makefile.

In ./Makefile (line #37), change the following:

$(LIVESCRIPT_BIN) $(BUILD_DIR)en.ls

To:

$(LIVESCRIPT_BIN) $(BUILD_DIR)de.ls

Run make test to make sure your translations compile properly. It might take a little while (~minutes) if you're on a slower computer.

Publishing Your Changes

Your newly translated site is available at './public/language-code/'. Visit it in your browser and check out your work. Looking good!

Remember to revert the Makefile change and then commit the changes and issue a pull request.

Contribute: Mirror

If you wish to mirror this site, nylira/prism-break-static is probably of interest to you. This is a completely static (but constantly updated) version of the site you can save to browse locally or serve over HTTP.

Mirrors

etheralghost has provided a Tor mirror:

http://hrk2gpercx3p6apf.onion/

License

See LICENSE.md.