|
1 |
| -# Do not manually edit this repository! |
| 1 | +This is the source code for www.tosdr.org. You should |
| 2 | +find more information about the project itself on the website. |
2 | 3 |
|
3 |
| -The contents of this repository are generated by the [tosdr-build repository](https://github.com/tosdr/tosdr-build). To make modifications to the website, alter that repository, build it, and commit the results here as described in the README of the tosdr-build repository. |
| 4 | +<!--Overview |
| 5 | +======== |
4 | 6 |
|
5 |
| -# Personal information |
| 7 | +We welcome other people to copy this project for other specific purposes (like a ToS;DR specific for API terms) or for country-specific (translation and national law issues). Just: |
| 8 | +
|
| 9 | + 1. open a public mailing list for people to contribute and start translating, |
| 10 | + 2. fork the code from https://github.com/tosdr/tosdr-build and translate, or adapt, etc. |
| 11 | + 3. change the name and the logo, and have a look at the license (AGPL for HTML/JS/CSS and CC BY SA for JSON) |
| 12 | +
|
| 13 | +--> |
| 14 | + |
| 15 | +The data specification is available [on the wiki][wiki]. |
| 16 | + |
| 17 | +[wiki]: https://github.com/tosdr/tosdr.org/wiki |
| 18 | + |
| 19 | +Personal information |
| 20 | +==================== |
6 | 21 |
|
7 | 22 | 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.
|
| 23 | + |
| 24 | +Clone this repository |
| 25 | +===================== |
| 26 | + |
| 27 | +There are git submodules in this repository. To automatically have them all, clone this repository with the `git clone --recursive` option. |
| 28 | +Alternatively, run `git submodule init` and `git submodule update` to pull in the submodules. |
| 29 | + |
| 30 | +Build |
| 31 | +===== |
| 32 | +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). |
| 33 | + |
| 34 | +To build: |
| 35 | + |
| 36 | +1. Make sure you have the git [submodule](http://www.git-scm.com/book/en/Git-Tools-Submodules) in the `dist/` folder and that it is up-to-date (see above). |
| 37 | + |
| 38 | + The source files are used to generate the content of the [tosdr.org repository](https://github.com/tosdr/tosdr.org), generated in the `dist/` folder. |
| 39 | + |
| 40 | +2. Run `npm install` in the root of this repository to make sure you have the required packages. |
| 41 | +3. Make the changes you wish to make to the source files in this repository. |
| 42 | +4. Run `grunt` or `./node_modules/.bin/grunt` in the root of this repository. |
| 43 | +5. Check whether the output in the dist/ directory is looking as intended. |
| 44 | +6. Commit and push both repositories. |
| 45 | +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 |
| 46 | + |
| 47 | +[@hugoroy]: https://github.com/hugoroy |
| 48 | +[@michielbdejong]: https://github.com/michielbdejong |
| 49 | + |
| 50 | +<!-- This should have its own README |
| 51 | +Import |
| 52 | +====== |
| 53 | +To import new and/or updated threads from the Google Group: |
| 54 | +
|
| 55 | +* Open [import/bookmarklet.html](https://tosdr.org/import/bookmarklet.html) with Firefox, and follow instructions there; save result to `./import/newThreadSubjects.json` in your checked out local git repo |
| 56 | +* Run `node ./import/prettifyNewThreadSubjects.js` |
| 57 | +* create `./import/imapCredentials.js` from `./import/imapCredentials.js.sample` |
| 58 | +* (from the repo root:) `git pull; npm install ; cd import ; mkdir rawPosts ; cd rawPosts ; node ../searcher.js` (you may have to set 'allow less secure apps' if the imap account is a gmail account). |
| 59 | +* `cd .. ; node threadMatcher.js > ../index/threads.json` |
| 60 | +* `cd .. ; node scripts/newPointsForNewThreads.js` |
| 61 | +* `./node_modules/.bin/grunt` |
| 62 | +* `git status ; git add . ; git commit -am"import from Google Groups"; git push; git push 5apps master` |
| 63 | +
|
| 64 | +Curate |
| 65 | +====== |
| 66 | +These scripts are what I (Michiel) currently use for curating points after import. The ideas is to integrate these into the web interface: |
| 67 | +
|
| 68 | +* `node scripts/curator.js` - will run a curating webinterface on http://localhost:21337/ that lets you change the (local) files on disk |
| 69 | +* `cd dist; node ../scripts/checkcases.js` - an interactive command-line tool that helps you assign cases to points that don't have one yet |
| 70 | +* `cd dist; node ../scripts/checkclasses.js` - outputs recommendations for adding/updating the class of services, based on their data points |
| 71 | +--> |
| 72 | + |
| 73 | + |
| 74 | +Develop other applications |
| 75 | +========================== |
| 76 | + |
| 77 | +API: http://www.tosdr.org/api.html |
| 78 | + |
| 79 | +Also have a look at other apps, like the browser extensions: https://github.com/tosdr |
| 80 | + |
| 81 | +## Core developpers |
| 82 | +* [Chris](https://github.com/piks3l) |
| 83 | +* [Michiel](https://github.com/michielbdejong) |
| 84 | + |
| 85 | +### Hosting |
| 86 | +People who have access to the hosting: |
| 87 | +* [Chris](https://github.com/piks3l) |
| 88 | +* [Ggrin](https://github.com/Ggrin) |
| 89 | +* [Hugo](https://github.com/hugoroy) |
| 90 | +* [Jan](https://github.com/jancborchardt) |
| 91 | +* [Jimm](https://github.com/JimmStout) |
| 92 | +* [Michiel](https://github.com/michielbdejong) |
| 93 | +* [Pierre](https://github.com/pierreozoux) |
| 94 | +* [Vinnl](https://github.com/Vinnl) |
| 95 | + |
| 96 | + |
| 97 | + |
| 98 | + |
| 99 | + |
| 100 | +License |
| 101 | +====== |
| 102 | + |
| 103 | +AGPL-3.0+ (GNU Affero General Public License, version 3 or later) |
| 104 | + |
| 105 | +See <https://tosdr.org/legal.html> for more details on the legal aspects of the project. |
0 commit comments