Skip to content

Latest commit

 

History

History
74 lines (48 loc) · 3.16 KB

README.md

File metadata and controls

74 lines (48 loc) · 3.16 KB

Newsnest

Header Banner

Newsnest is a modern, self-hosted RSS reader web app, giving you complete control over your news feeds. Built with PHP8 and MySQL, it works on any modern web host or home server, making it easy to keep up with your favorite content in one place.

📰 About the Project

Newsnest is currently in development, with an early alpha version available internally. We are dedicated to making this a feature-rich and user-friendly platform. The app supports RSS, ATOM (and soon JSON Feed), and allows you to organize and read your news feeds effortlessly.

✅ Features

  • Modern UI: Enjoy a sleek, responsive interface with the option to view articles in list or card layouts.
  • Feed Management: Organize your RSS/ATOM feeds into categories for easy access.
  • Automatic Cleanup: The app automatically removes old posts to keep your feed organized.
  • Self-hosted Solution: Run Newsnest on your personal website, LAN, or home server for complete control over your feeds.
  • Future Support for JSON Feed: We're actively working on supporting the JSON Feed format.

🚧 Work in Progress

  • Newsnest is a work in progress, and we will regularly update this README with new features and improvements. Stay tuned for more exciting developments!
  • Contributions are welcomed to help shape the future of Newsnest, whether through code, feedback, or donations.

🚀 Getting Started

Newsnest is in early development. Once we have the first simple app ready, we'll add a comprehensive getting started guide here.

You'll be able to run Newsnest on any modern webspace. We recommend nginx + PHP 8 + MariaDB.

💬 Contributions

We encourage and welcome contributions from the community! Whether you're fixing bugs, adding features, or improving the documentation, your help is highly appreciated.

💁‍♀️ How to Contribute

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature/YourFeature).
  3. Commit your changes (git commit -am 'Add your feature').
  4. Push the branch (git push origin feature/YourFeature).
  5. Open a pull request on GitHub.

💸 Support the Project

Contributions and donations help us maintain and grow Newsnest. Your support makes a huge difference in improving the platform. Consider supporting the project by donating via our donation page.

⚖ License

Newsnest is licensed under the Mozilla Public License 2.0. You are free to use, modify, and distribute the software, provided that modifications are also shared under the same license. See the LICENSE.md file for details.

⭐ Stay Updated

This project is a work-in-progress, and we will continue to post updates here. Follow us on GitHub and star this project to stay up to date with the latest changes.

🏢 Credits

Newsnest is developed and maintained by the team at Neoground GmbH. We aim to push the boundaries of digital solutions, with a focus on modern, responsive, and intelligent apps.

Copyright (c) 2024 Neoground GmbH