Contributing

Local Setup

You will need:

node.js >= 0.1.0
yarn >= 1.22.5
Visual Studio Code (You may also use other editors, but everything is already configured for this one)

First, clone the project from GitHub:

Using HTTPS:

git clone https://github.com/TimJentzsch/tor-user-stats.git

Using SSH:

git clone git@github.com:TimJentzsch/tor-user-stats.git

Don't forget to navigate to the folder:

cd tor-user-stats

Now you can install the dependencies:

yarn install

The project needs to interact with the reddit API. Therefore, you have to create a reddit application.

Navigate to the reddit app settings.
Make sure that you have read the API usage guidelines.
Create a new application. Give it a meaningful name and choose "installed app" as type.
You will need the ID of the app that you have created. It will be displayed right under "installed app".
Read and fill out the API registration form.
In the project files, navigate to config/ and copy the contents of reddit.example.config.json to a new file named reddit.config.json.
Insert the above mentioned client ID and your user name in the appropriate properties.

You should now be able to start the app via yarn start. This will run the analysis for the user specified in the reddit.config.json.

To run the analysis for a specific user, use:

yarn start <username>

You can also run the web-view locally by using

yarn serve