removeddit/README.md
2022-03-25 16:53:39 +00:00

32 lines
1.4 KiB
Markdown

# Unddit
[Unddit](https://www.unddit.com) is a site for undoing the removal of comments for [Reddit](https://www.reddit.com).
Just go to any Reddit post and replace the `re` of `reddit` in the URL with `un` to see all removed comments.
This is a done by comparing the comments being stored in [Jason Baumgartner's](https://pushshift.io/) [Pushshift Reddit API](https://github.com/pushshift/api) and the ones from Reddit's API. The frontend, developed by Jesper Wrang and originally available at [removeddit.com](https://removeddit.com), is written in [React](https://reactjs.org/) and uses [Sass](https://sass-lang.com/) as the CSS Preprocessor.
# Development
Download Unddit:
```bash
git clone https://github.com/gurnec/removeddit.git
```
Download [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm), or update your existing npm to the latest version:
```bash
mkdir npm && cd npm
npm --no-package-lock install npm
mv node_modules ../removeddit/ && cd ../removeddit && rmdir ../npm
alias npm="$(pwd)/node_modules/.bin/npm"
```
Build the Javascript files and launch a local server for development:
```bash
npm install
npm start
```
Visit http://localhost:8080 and make sure the site is running. If you're getting connection errors to Reddit or Pushshift, it might be because you're running a VPN. Try turning it off for development.
The CSS is built separately (to keep the build steps / configs very simple) by running:
```bash
npm run css
```