News-API

Developed by:

Hosted on heroku: https://n.herokuapp.com/

Description

The Bulletin is an application that consumes the News API to provide users with a means of viewing news from around the world as broadcast by various sources. It is built using the Python Flask framework.

BDD

The user is able to:

See various news sources on the homepage of the application.
Select a news source on click and see all news articles from the selected news source in the application.
See the image, description and the time a news article was created.
Click on an article and read the full article on the source website.

Installation Requirements

Python3.8
Flask 2.0.2
pip

Cloning

Run $ git clone https://github.com/mwikalikyalo/news-API on your terminal

Running the Application

After cloning, in the terminal:

$ cd news-API
$ python3 -m venv virtual (to create a virtual environment)
$ source virtual/bin/activate (to activate virtual environment)
$ pip install flask
$ pip install Flask-Bootstrap
$ pip install flask-script
$ ./start.sh to execute

Running unit tests

$ python3.8 manage.py test

Bugs

No known bugs. Pull requests encouraged to improve the app.

Technologies used

Python3.8
Flask 2.0.2
Bootstrap v5
gunicorn

Contacts

You can reach me through:

Email: winniemwikali07@gmail.com or

License

MIT License:

mwikalikyalo/news-API