https://github.com/nealwaga/news-api
This is a web application that displays a list of various news sources. On choosing a news source, it will preview the top news articles of the day. Clicking a news article will redirect the user to read it fully from the news source.
https://github.com/nealwaga/news-api
flask python
Last synced: 2 months ago
JSON representation
This is a web application that displays a list of various news sources. On choosing a news source, it will preview the top news articles of the day. Clicking a news article will redirect the user to read it fully from the news source.
- Host: GitHub
- URL: https://github.com/nealwaga/news-api
- Owner: nealwaga
- Created: 2022-04-30T13:09:51.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2022-05-09T05:28:42.000Z (about 3 years ago)
- Last Synced: 2025-01-10T04:12:10.041Z (4 months ago)
- Topics: flask, python
- Language: Python
- Homepage: http://44.200.116.238:6010/
- Size: 12.4 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# News-API
***
**Description**
---
This is a web application that displays a list of various news sources. On choosing a news source, it will preview the top news articles of the day. Clicking a news article will redirect the user to read it fully from the news source.
***
**User Stories**
---
These are the behaviours/features that the application implements for use by a user.
As a user I would like to:
* See various news sources.
* Select the ones they prefer.
* See the top news articles from that news source.
* See the image, description and time the news article was created.
* Click on an article and read it fully from the news source.
***
**Set-Up / Installation Requirements**
---
### Cloning
* In your terminal:
`$ git clone https://github.com/nealwaga/News-API`
`$ cd News-API`
---
### Running the Application
* Creating the virtual environment:
`$ virtualenv virtual`
`$ source virtual/bin/activate`
`$ curl https://bootstrap.pypa.io/get-pip.py | python`
* Intsalling Flask and other Modules:
`$ python3.6 -m pip install Flask`
`$ python3.6 -m pip install Flask-Bootstrap`
`$ python3.6 -m pip install Flask-Script`
* Setting up the API key:
To be able to gather article info from the News API you will need an API Key.
* Visit https://newsapi.org/ and register for an API key.
* In the root directory of the project folder create a file: start.sh
* Insert the following info into it:
export NEWS_API_KEY=''
python3 manage.py server
* Insert the API Key you received from News Api where is.
* To run the application, in the terminal:
`$ chmod +x start.sh`
`$ ./start.sh`
---
**Technologies Used**
---
* Python 3.8
* Flask
* HTML
* CSS
---
**License**
---
This software is licensed under the MIT license. Copyright (c) 2022 Neal Waga