https://github.com/akash1362000/news-web-app
News Web App 📰 built using Python Django 🌐 and NewsAPI 🚀 Fetches latest news. 😍 It is a Progressive Web App (PWA) which enables users 👨👩👦 to install it on their mobile phones 📱 (Android & iOS) as well as Desktop 💻 (Windows, Linux, etc.) 🔥
https://github.com/akash1362000/news-web-app
css django django-application html javascript materialize-css mobile-first news newsapi newsapi-python progressive-web-app pwa pwa-apps python
Last synced: about 1 year ago
JSON representation
News Web App 📰 built using Python Django 🌐 and NewsAPI 🚀 Fetches latest news. 😍 It is a Progressive Web App (PWA) which enables users 👨👩👦 to install it on their mobile phones 📱 (Android & iOS) as well as Desktop 💻 (Windows, Linux, etc.) 🔥
- Host: GitHub
- URL: https://github.com/akash1362000/news-web-app
- Owner: Akash1362000
- License: mit
- Created: 2020-08-13T08:49:03.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-01-30T08:18:32.000Z (over 2 years ago)
- Last Synced: 2025-03-24T17:55:16.434Z (about 1 year ago)
- Topics: css, django, django-application, html, javascript, materialize-css, mobile-first, news, newsapi, newsapi-python, progressive-web-app, pwa, pwa-apps, python
- Language: HTML
- Homepage: https://news-web-app-8pf8.onrender.com/
- Size: 11.6 MB
- Stars: 27
- Watchers: 3
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# News-Web-App
[](https://newswebapp.herokuapp.com/)
[](https://travis-ci.com/github/Akash1362000/Django_Student_Management_System/)
[](https://hits.seeyoufarm.com)
[](https://github.com/Akash1362000/News-Web-App/graphs/commit-activity)
News Web App 📰 built using Python Django 🌐 and NewsAPI 🚀 Fetches latest news. 😍 It is a Progressive Web App (PWA) which enables users 👨👩👦 to install it on their mobile phones 📱 (Android & iOS) as well as Desktop 💻 (Windows, Linux, etc.) 🔥
Checkout the live Website [here](https://news-web-app-8pf8.onrender.com/)!
Find the detailed project report [here](https://drive.google.com/file/d/1CotBwalG53YZ9wDjjDHIA-nrLDLWkJHn/view?usp=sharing)! 📜
### Demo 🎥
### Meet the Developers ✨🌟
Akash Shrivastava
👨💻🚴♂️📸
Akanksha Tamboli
💻🎨
Shreejit Nair
🎓🏏📱 
Samiksha Naik
💃📸
## Development 🛠
Note : Make sure you have Python version 3.8+ and Postgres 14 or above
Environment Setup
`$ git clone https://github.com/Akash1362000/News-Web-App.git`
`$ cd News-Web-App/`
Create `.env` file (refer `.env.example` file)
Generate `SECRET_KEY` from [here](https://djecrety.ir/)
Get your `NEWS_API_KEY` from [here](https://newsapi.org/)
## Database Setup
Install Postgres Latest version from [here](https://www.postgresql.org/download/)
Install pgAdmin from [here](https://www.pgadmin.org/download/)
Create a Database using pgAdmin by following the steps mentioned [here](https://www.tutorialsteacher.com/postgresql/create-database)
Update your `DATABASE_URL` in `.env` with your DB details like `USER`, `PASSWORD` and `DB_NAME`
---
If virtualenv is not installed [(What is virtualenv?)](https://www.youtube.com/watch?v=N5vscPTWKOk&t=313s):
`$ pip install virtualenv`
Create a virtual environment
`$ virtualenv venv`
Activate the environment everytime you open the project
`$ source venv/Scripts/activate`
Install requirements
`$ pip install -r requirements.txt`
`$ pre-commit install`
`$ python manage.py migrate`
---
Create superuser
`$ python manage.py createsuperuser`
---
That's it. You're all Set!
To run the server:
`$ python manage.py runserver`
Open your desired browser and head over to [http://127.0.0.1:8000/](http://127.0.0.1:8000/)
To exit the environment
`$ deactivate `
---
## Docker Setup (Optional) 
If you want to use Docker to run this project, you need to do the following steps:
- Install Docker for your OS from [here](https://www.docker.com/products/docker-desktop/)
- Run `docker --version` and `docker compose --version` [In Windows, you need to run `docker-compose --version` to check the version]
- If you see both the versions, then Docker is successfully installed on your system and you can follow along
- If you don't see the version, check with your Docker installation
- Open `docker-compose.yml` file and update the value of `NEWS_API_KEY` with your generated key. You can generate it from [here](https://newsapi.org/)
- Run `docker compose up -d`
- Run `docker exec -it news_web_app sh -c "python manage.py createsuperuser"` to create a new superuser
- Access the app at [http://localhost:8000](http://localhost:8000)
- To stop the container, run `docker compose stop` from the project root
- To restart the container, run `docker compose start` from the project root
- To delete the container, run `docker compose down` from the project root
---
## Stargazers
[](https://github.com/Akash1362000/News-Web-App/stargazers)
Leave a ⭐ from [here](https://github.com/Akash1362000/News-Web-App) if you like 😁
---
### License ✍
```
MIT License
Copyright (c) 2020 Akash Shrivastava
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.
```