Skip to content
This repository has been archived by the owner on Jan 10, 2021. It is now read-only.

Latest commit

 

History

History
124 lines (85 loc) · 5.26 KB

README.md

File metadata and controls

124 lines (85 loc) · 5.26 KB
Raw

This Repository is archived in favor of https://github.com/tosdr/CrispCMS

Everything has been moved there!

This is the source code for www.tosdr.org. You should find more information about the project itself on the website.

The data specification is available on the wiki.

Personal information

This repo might contain information that was not intended to be public. In that case, please open a PR here or send us an email at team at tosdr dot org.

Clone this repository

There are git submodules in this repository. To automatically have them all, clone this repository with the git clone --recursive option. Alternatively, run git submodule init and git submodule update to pull in the submodules.

Build

Most of the website's source files are located in the src/ directory (although unfortunately some of it is still intermingled with the build files).

To build:

  1. Run npm install in the root of this repository to make sure you have the required packages.
  2. Make the changes you wish to make to the source files in this repository.
  3. Run grunt or ./node_modules/.bin/grunt in the root of this repository.
  4. Check whether the output in the dist/ directory is looking as intended.
  5. cp -r api/ dist/ . (needed for https://github.com/duckduckgo/duckduckgo-privacy-extension)
  6. Commit and push to github.
  7. To publish the new version of the website, assuming you have 5apps set up as a remote, run git subtree push --prefix dist 5apps master. But be careful: this updates the live site! Ask @hugoroy or @michielbdejong if you don't have permission

Using npm to build:

  1. Run npm install in the root of this repository to make sure you have the required packages.
  2. Make the changes you wish to make to the source files in this repository.
  3. Run npm run compile in the root of this repository
  4. Check whether the output in the dist/ directory is looking as intended.
  5. Commit and push to github using npm run publish

Using npm to build and publish in one command:

  1. Run npm install in the root of this repository to make sure you have the required packages.
  2. Make the changes you wish to make to the source files in this repository.
  3. Run npm run compileandpublish in the root of this repository

Develop other applications

API: http://www.tosdr.org/api.html

Also have a look at other apps, like the browser extensions: https://github.com/tosdr

Core developpers

Hosting

People who have access to the hosting:

License

AGPL-3.0+ (GNU Affero General Public License, version 3 or later)

See https://tosdr.org/legal.html for more details on the legal aspects of the project.