sdailey / tosdr-build

System to generate ToS;DR projects

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.

Clone this repository

There are git submodules in this repository. To automatically have them all, clone this repository with the git clone --recursive option.

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. Make sure you have the git submodule in the dist/ folder and that it is up-to-date (i.e. by running git submodule add https://github.com/tosdr/tosdr.org.git dist and cd dist && git pull).

   The source files are used to generate the content of the tosdr.org repository, generated in the dist/ folder.

2. Run npm install in the root of this repository to make sure you have the required packages.

3. Make the changes you wish to make to the source files in this repository.

4. Run grunt in the root of this repository.

5. Check whether the output in the dist/ directory is looking as intended.

6. Commit and push both repositories.

7. To publish the new version of the website, assuming you have 5apps set up as a remote in the dist/ folder, run git push 5apps master. But be careful: this updates the live site! Ask @hugoroy or @michielbdejong if you don't have permission

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

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.