Aggregator

A simple way to follow your favourite RSS feeds!

View Demo · Report Bug · Request Feature

Table of Contents

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

About The Project

This project was initially inspired by a challenge I saw somewhere on the internet a while back. I actually began building it however, when I was tracking news about a particular country across multiple sources, and decided it would be a lot easier to have feeds from those sources all in one place to go through. It is the first of many more projects to be added to my github in an attempt to make sure I have work to show for myself apart from projects built for my employers.

Without signing in with your google account, you'll still have access to the general application in order to see how it works with some sample feeds and sources. However, you will not be able to add or edit any data.

(back to top)

Built With

• Next.js
• React.js
• Tailwindcss
• Firebase

(back to top)

Getting Started

Prerequisites

You'll need to have node installed, and either npm or yarn (preferred).

• npm

  npm install npm@latest -g

Installation

1. Get a free API Key at https://example.com

2. Clone the repo

   git clone https://github.com/NathanDowner/aggregator.git

3. Install dependencies

   yarn install

   or

   npm install

4. Supply your Firebase env variables to satisfy the firebaseConfig object in the firebase.js file(#)

   const firebaseConfig = {
    apiKey: process.env.NEXT_PUBLIC_FIREBASE_API_KEY,
    authDomain: process.env.NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN,
    databaseURL: process.env.NEXT_PUBLIC_FIREBASE_DATABASE_URL,
    projectId: process.env.NEXT_PUBLIC_FIREBASE_PROJECT_ID,
    storageBucket: process.env.NEXT_PUBLIC_FIREBASE_STORAGE_BUCKET,
    messagingSenderId: process.env.NEXT_PUBLIC_FIREABSE_MESSAGING_SENDER_ID,
    appId: process.env.NEXT_PUBLIC_FIREBASE_APP_ID,
    measurementId: process.env.NEXT_PUBLIC_MEASUREMENT_ID,
   };

(back to top)

Roadmap

• Add 'Saved Articles' section
• Add scroll-to-top
• Add dark mode
• Allow user to select different icons when creating feeds See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

While this is a personal project, any contributions you make are greatly appreciated.

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.

(back to top)

Contact

Nathan Downer - @Nathan_Downer - [email protected]

Project Link: https://github.com/NathanDowner/aggregator

(back to top)

Acknowledgments

• Hero Icons
• Headless UI
• react-masonry-css

(back to top)