Web frontend for the Reddit Map Project

Reddit Map is a project of computer, data, and social scientists to explore and visualize Reddit. The website running the visualizations is available at https://redditmap.social. The code that runs the web frontend is here.

Reddit Map is a collaboration between the Initiative for Digital Public Infrastructure (iDPI), Media Cloud, and the UMass Amherst Center for Data Science.

Install dependencies with npm install.

Start a development server:

npm run dev

# or start the server and open the app in a new browser tab
npm run dev -- --open

After you commit changes to our development mainline branch, main, you'll want to cut a release and publish changes for the world to see. We've setup a GitHub action to make that easy for you.

Merge the branch main into publish. The publish action will take care of the rest for you, building the site static resources, syncing remote files, and dealing with HTTP caching. It will take several minutes for the build, sync, and HTTP cache invalidation tasks to complete.

There are Gulp tasks that allow you to perform other actions, but most people won't need to use them if they're working directly on the application layer.

You only need this if you're setting up an endpoint for the first time, or if the infrastructure configuration needs to be updated. Note that you'll need sufficient permissons in iDPI's AWS account.

AWS_PROFILE=idpi npx gulp deploy --environment=production-www

To manually build assets, use:

npx gulp build

You can run the publish action locally, if you have permissions with iDPI's AWS account. Use the following command:

AWS_PROFILE=idpi npx gulp publish --environment=production-www

Reddit Map is free, open-source software licensed under the MIT License.

You can open issues for bugs you've found or features you think are missing. You can also submit pull requests to this repository. To get started, take a look at CONTRIBUTING.md.