Skip to content

tomson611/NewsRead

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

82 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

NewsRead

Application for reading, searching through and checking sources of online news articles.

Status

Work in progress.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

Python: 3.12
Django: 5.0

Installing

  1. Clone the repository
git clone https://github.com/tomson611/NewsRead.git
  1. Create your own virtual environment
python3 -m venv venv
source venv/bin/activate
  1. Install requirements
pip install -r requirements.txt
  1. Generate a new secret key

You can use Djecrety to quickly generate secure secret keys.

  1. Make your migrations

In your terminal:

$ python manage.py makemigrations$ python manage.py migrate
  1. Create a new superuser
python manage.py createsuperuser
  1. Get a NewsAPI API key.
  2. Create a local_settings.py file in the newsread directory.
  3. Create an API_KEY variable and provide the key from step 7.
  4. Run the dev server
python manage.py runserver

Deployment

You can deploy on any hosting of your choice for example PythonAnywhere

Built With

  • Django - The web framework used
  • Requests - HTTP library for Python
  • NewsApi - News API is a simple, easy-to-use REST API that returns JSON search results for current and historic news articles published by over 80,000 worldwide sources.

Code of Conduct

Code of Conduct

Authors

  • Tomasz Wesołowski - Initial work - tomson611

License

This project is licensed under the MIT License - see the LICENSE.md file for details

About

No description, website, or topics provided.

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published