Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/expresshermes/singular-news
A Django news app powered with machine learning to provide personalised feed to the users based on their interactions on the app.
https://github.com/expresshermes/singular-news
bing-news bootstrap-5 django hacktoberfest machine-learning news python
Last synced: 3 months ago
JSON representation
A Django news app powered with machine learning to provide personalised feed to the users based on their interactions on the app.
- Host: GitHub
- URL: https://github.com/expresshermes/singular-news
- Owner: ExpressHermes
- License: gpl-3.0
- Created: 2020-07-15T06:02:49.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-12-08T11:23:56.000Z (about 2 years ago)
- Last Synced: 2024-10-11T06:42:41.900Z (3 months ago)
- Topics: bing-news, bootstrap-5, django, hacktoberfest, machine-learning, news, python
- Language: HTML
- Homepage:
- Size: 388 KB
- Stars: 11
- Watchers: 3
- Forks: 9
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Singular News
[](https://gitter.im/ExpressHermesOSC/Singular-News?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
A news app powered with machine learning to provide personalized feed to the users based on their interactions on the app.
# Installation
## Prerequsites
- Python
- Django
- PostgreSQL
## How to set up locally
- Fork and clone repo on your machine.
```
git clone https://github.com/ExpressHermes/Singular-News.git
```
- Create a virtual environment. Activate it. Make sure it is in the same directory as the cloned repo.
```
# for linux users
python -m venv
source venv/bin/activate
```
- Install all requirements.
```
pip install -r requirements.txt
```
- In settings.py inside Indus, replace email settings with your email address and password to allow email verification. Remember to remove these when committing to github.
```
EMAIL_HOST_USER = os.environ.get('EMAIL_HOST_USER') # relpace with your email
EMAIL_HOST_PASSWORD = os.environ.get('EMAIL_HOST_PASSWORD') # replace with email password
```
- Inside the project folder, create migrations for the apps `users` and `feeds`
```
python manage.py makemigrations
python manage.py migrate
```
- Run the project
```
python manage.py runserver
```
# Contribution Guidelines
- Fork and star the repo.
- Add a upstream link to main branch in your cloned repo
```
git remote add upstream https://github.com/ExpressHermes/Singular-News.git
```
- Keep your cloned repo upto date by pulling from upstream (this will also avoid any merge conflicts while committing new changes)
```
git pull upstream master
```
- Create your feature branch
```
git checkout -b
```
- Commit all the changes
```
git commit -am "Meaningful commit message"
```
- Push the changes for review
```
git push origin
```