prehistoric-systems/removeddit
1
0
Fork 0
mirror of https://github.com/gurnec/removeddit.git synced 2026-03-11 08:54:27 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update README

Browse source
This commit is contained in:
Jesper Wrang 2019-12-05 10:11:18 +01:00
parent dfcb1d653d
commit 4bff672157
3 changed files with 11 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -2,30 +2,21 @@
[Removeddit](https://removeddit.com) is a site for viewing removed comments / threads from [Reddit](https://www.reddit.com).
Just go to any reddit thread and change the `reddit` in the URL to `removeddit` to see all removed comments.
This is a done by comparing the comments being stored in [Jason Baumgartners](https://pushshift.io/) [Pushshift Reddit API](https://github.com/pushshift/api) and the ones from Reddit API. The frontend is written in [React](https://reactjs.org/) and uses [Sass](https://sass-lang.com/) as the CSS Preprocessor. There is also a seperate [backend](https://github.com/JubbeArt/removeddit-api) used for storing what threads that have been removed by mods.
This is a done by comparing the comments being stored in [Jason Baumgartners](https://pushshift.io/) [Pushshift Reddit API](https://github.com/pushshift/api) and the ones from Reddit API. The frontend is written in [React](https://reactjs.org/) and uses [Sass](https://sass-lang.com/) as the CSS Preprocessor. There is also a seperate [backend](https://github.com/JubbeArt/removeddit-api) used for storing what threads that have been removed by mods. This backend is really just a mirror of [/r/undelete](https://www.reddit.com/r/undelete/).
# Development
Download either [Yarn](https://yarnpkg.com/en/docs/install) (the one I use) or [npm](https://www.npmjs.com/get-npm)
```bash
sudo git clone https://github.com/JubbeArt/removeddit.git && cd removeddit
git clone https://github.com/JubbeArt/removeddit.git && cd removeddit
# npm...
npm install
npm start
# or yarn
yarn
yarn start
```
This will build the Javascript files and launch a local server for development. Visit http://localhost:8080 and make sure the site is running.
The CSS is build seperatly (to keep the build steps / configs very simple) by running
```bash
# npm
npm run build-sass
# yarn
yarn run build-sass
```

12
src/pages/about/index.js
View file

@ -34,16 +34,16 @@ const About = props => {
<a href='https://github.com/JubbeArt/'> Jesper Wrang </a> and uses
<a href='https://pushshift.io/'> Jason Baumgartner </a> service for getting removed comments.
</p>
<h2 className='todo'>TODO</h2>
<ul>
<li>Collapsing comments</li>
<li>Maybe for specific users </li>
</ul>
<h2 className='todo'>FAQ</h2>
<b>Q: I posted some sensitive information on Reddit. Can you delete this from your page?</b>
<p>a</p>
<b>Q: How does it work?</b>
<h2 className='contact'>Links/Contact</h2>
<p style={{ marginBottom: '8px' }}>For feedback and bug reports:</p>
<ul>
<li>email: removeddit (at) gmail.com</li>
<li>reddit: <a href='https://www.reddit.com/user/Jubbeart/'>/u/JubbeArt</a></li>
<li>reddit: <a href='https://www.reddit.com/user/Jubbeart/'>/u/JubbeArt</a> (not active anymore)</li>
</ul>
<p>
<a href='https://github.com/JubbeArt/removeddit'>Code on Github.</a>

6
src/pages/common/Header.js
View file

@ -10,14 +10,14 @@ const Header = props => (
</h1>
<nav>
<Link to='/r/all'>/r/all</Link>
<Link to='/about/'>about</Link>
<Link to='/about/'>about & FAQ</Link>
</nav>
</div>
<div id='status'>
{props.global.state.statusText &&
<p id='status-text'>{props.global.state.statusText}</p>}
<p id='status-text'>{props.global.state.statusText}</p>}
{props.global.state.statusImage &&
<img id='status-image' src={props.global.state.statusImage} alt='status' />}
<img id='status-image' src={props.global.state.statusImage} alt='status' />}
</div>
</header>
)