FlaskNews

This is a Flask application that helps users list and preview news articles from various sources.

Project Run-Through

• A few details about this project:

Contribution

• Kelvin Mburu 📖

Technology Used

1. Python3
2. Flask version 2
3. HTML, CSS and JavaScript
4. News API
5. C
6. Shell

Project Requirements & Prerequisites

1. IDE of Choice
2. Python3
3. Browser

• Please ensure you're working from a Windows/MacOS/Linux
• Install Flask through pip flask install

Project Setup and Installation

1. Proceed to this link and clone the repository.
2. Extract the folder and cd to the folder on your terminal or your prefered IDE
3. In the terminal, create a virtual/flask environment: python3 -m venv virtual and activate it through source virtual/bin/activate. In the case of flask, please use source flask/bin/activate.
4. Install all dependencies from the requirements.txt file; use pip to install needed dependencies.
5. In the project folder, create a start.sh file which acts as a server at runtime.
6. In the terminal, and within the project folder, run chmod +x start.sh and ./start.sh to start the project.
7. View the application on your browser on http://127.0.0.1:5000. If you have another project running on another port, use flask run --host 0.0.0.0 --port 5001 to switch to a new port; You can use a different port number.

Behavior Driven Development (BDD)

The BDD focuses on how a user interacts with the application.

At a minimum, this is what the user should experience in the application:

• Main landing page with a list of articles from different authors and sources.
• By using the navbar, the user can navigate to different articles from different domains such as health or business.
• By using the search from on the navbar, the user can search for their favorite article.
• If a user clicks on a particular article link, they are redirected to the article's page where they can read it.
• Navigating to a different news section such as Kenya allows a user to read articles from that particular country.

Project Contribution or Development:

To contribute to this project, please follow the following steps:

• Fork this repository.
• Create a branch: git checkout -b <branch_name>.
• Make your changes and commit them: git commit -m '<commit_message>'
• Push to the original branch: git push origin <flask-news>/<main>
• Create the pull request and wait for a PR review

Please see the GitHub documentation on Creating a Pull Request

Known Issues & bugs

To improve this project or fix a bug, please reach me via Email:

• mburuhkelvin@gmail.com
• kelvin.anjiku@student.moringaschool.com

Alternatively, you can contact me via LinkedIn

License

Please view the project LICENSE for more information.