Skip to content

A Simple & beautiful News article application built in Flask/Python & NewsApi.

License

Notifications You must be signed in to change notification settings

anuraagnagar/article-bucket

Repository files navigation

Article bucket

This Flask-based news article application provides users with a convenient way to access news articles from different sources and categories. Users can easily stay informed about current events and trending topics through a user-friendly web interface.

Screenshots

Home Page showing latest news.

Home Page

Category Page showing according to listed category.

Category Page

Search news according to your need.

Search Page

Library & Modules

  • FLask
  • FLask-Caching
  • Newsapi-Python
  • Jinja2

Features

  • Fetches news articles from NewsAPI.
  • Displays news articles in a user-friendly format.
  • Allows users to search for specific topics.
  • Allows users to read news from different categories.

Installation & Set Up Locally.

Prerequisites

  • Python 3.x
  • Virtual environment tool (e.g., venv or virtualenv)
  • Git (optional, but recommended for cloning the repository)

1. Clone this repository.

git clone https://github.com/anuraagnagar/article-bucket.git

2. Go to the directory.

cd article-bucket

3. Create Virtual Environment.

python -m venv venv

4. Activate the Environment.

On Windows

venv\scripts\activate

On MacOS/Linux

source venv/bin/activate

API Key

You need to convert .env.example to .env file in your base directory and set your newsapi API_KEY environment variable value.

5. Install the requirement package.

pip install -r requirements.txt

6. Run the Server.

flask run

To access this application open http://localhost:5000 in your web browser.

Contributing

Contributions are welcome! If you find a bug or want to add a new feature, please open an issue or submit a pull request. For more information checkout CONTRIBUTING.md

Licence

By contributing to this project, you agree that your contributions will be licensed under the MIT License.

About

A Simple & beautiful News article application built in Flask/Python & NewsApi.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published