Hackereddit

A programming-focused reddit client for the Codecademy fullstack course.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Everyone's gotta build a Reddit clone at some point and for me, that point is now. This is my portfolio project for the Codecademy React & Redux section of the Full Stack path. I'm deliberately not overengineering this.

The goal here is a relatively minimal app with a few flourishes. I'm attempting to use API features to help you filter for quality content that will improve your ability to learn and answer questions.

There's a wealth of information on reddit but it lacks the emphasis on quality, authoritativeness, and moderation that Stackoverflow has. I've found that for certain questions or problems, Reddit is a better place to find an answer or learn more about the topic than Stackoverflow is.

(back to top)

Built With

(back to top)

Getting Started

I'll update this section after I'm done.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install npm@latest -g

Installation

Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.

1. Get a free API Key at https://example.com
2. Clone the repo

   git clone https://github.com/your_username_/Project-Name.git

3. Install NPM packages

   npm install

4. Enter your API in config.js

   const API_KEY = 'ENTER YOUR API';

(back to top)

Roadmap

See the project roadmap for a list of planned features and up-to-date information on progress.

(back to top)

Contributing

Note I'd be wildly surprised if anyone wants to contribute to this but for the sake of readme completeness, I've added this section.

If you have a suggestion that would make this better, please create an issue. If you'd like to contribute, don't start coding until you've created an issue and gotten approval from me. 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)

Contact

Michael Monaghan - @earnestposting - [email protected]

Project Link: https://github.com/Nostromos/hackereddit

(back to top)

Acknowledgments

(back to top)