README.md

RedditMini

A minified, customizable Reddit client.

Live Site · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Technologies
2. Roadmap
3. Contributing
4. License
5. Acknowledgments

About The Project

RedditMini is a Reddit client with an emphasis on customization. Users can select from various theme templates, dark & light versions, and select a background image to scroll Reddit in style.

User's can interact with the client in the following ways:

• Save posts to a separate feed
• Follow or block communities (subreddits)
• Search communities to follow
• Hide posts
• Select theme & background

(back to top)

Technologies

Libraries, frameworks & APIs used to create this app:

• React.js
• Redux
• Typescript

(back to top)

Roadmap

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Acknowledgments

Here's a list of helpful resources used to bring this project to life:

• Reddit .JSON API
• GitHub Pages
• React Icons

(back to top)