artisticLogicMK / falconry

A highly-performant RSS reader with stunning aesthetics, elegant UI, easy feed organization, a public profile, and daily auto-updated articles for seamless news hunting, and more.

Falconry - RSS Reader

Welcome to Falconry Github repository! A highly-performant RSS reader with stunning aesthetics, elegant UI, easy feed organization, a public profile, and daily auto-updated articles for seamless news hunting, and more.

Technologies Used

Features

• A visually captivating interface for an exceptional experience.
• Stay effortlessly informed with daily-updated articles.
• Add RSS feeds via links or discover from a curated list.
• Switch between light and dark modes for a personalized experience.
• Share your passion with others by sharing your public profile.
• Access a beautiful settings page for a personalized experience.
• Smooth user experience, making Falconry your go-to RSS reader.
• And more...

Getting Started

Make sure to install the dependencies:

# npm
npm install

# yarn
yarn install

# pnpm
pnpm install --shamefully-hoist

Development Server

Start the development server on http://localhost:3000

npm run dev

Production

Build the application for production:

npm run build

Locally preview production build:

npm run start

Check out the deployment documentation for more information.

Environment Variables

Change .env.example to .env.local and set your own values.

How to Contribute

1. Fork the repository
2. Create a new branch: git checkout -b new-feature
3. Make your changes and commit: git commit -m 'Add new feature'
4. Push to the branch: git push origin new-feature
5. Create a pull request

Feel free to reach out with any questions or suggestions.