/NewSourceApp

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.

Primary LanguagePython

NewSourceApp

An application that consumes the News - API and displays news sources and articles.

An IDE such as VS code with Python version 3 installed,a terminal and a browser.

Setup and Instruction

  1. Clone the repository at here.
  2. Extract and open the folder on VS code or navigate to the folder on your terminal.
  3. On the terminal, create a virtual environment python3 -m venv virtual and activate it source virtual/bin/activate. NB virtual is the name of the environment.
  4. Pip install dependancies highlighted on the requirements.txt by running pip install -r requirements.txt Create a start.sh file in the root directory of the folder and define the api key. You can generate the api key from the News API here
  5. Run chmod +x start.sh and ./start.sh respectively on the terminal.

Development

To fix a bug or enhance an existing module, follow these steps:

  1. Fork the repo
  2. Create a new branch (git checkout -b improve-feature)
  3. Make the appropriate changes in the files
  4. Add changes to reflect the changes made
  5. Commit your changes (git commit -am 'Improve feature')
  6. Push to the branch (git push origin improve-feature)
  7. Create a Pull Request

Known Bugs

There are no known bags

Support and Contact DetailS

Feel free to call me or email me with respective contacts detail:

+254743715669 wanguia822@gmail.com

License

MIT license copyright@ 2022 ann wangui Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.