News

Project structure

views - Views handling functions
models - Models and forms
config - Configuration and application setup
lib - Various utilities, almost everything is here
scripts - Scripts which shell be run separatly
static - Css, Js, Fonts and Images
templates - Templates, obviously

If you want to hop in I recommend going through models and views first, If anything is unclear or hidden under some function it will probably be in lib where almost everything is.

Models

Most models extend Base which is wrapper around Model from Orator library and provides base functions for DB access and caching. If anything is unclear it can most likely be found on Orator docs or in Base model.

Everything is heavily cached so all changes are written to DB and also to Redis which is considered a second source of truth. To access the cache and perform modifications to existing objects try to use as much from Base model as possible and be really careful when creating model-specific functions.

Views

We try to keep views as simple as possible and also human readable. Models and lib should handle most things and views just use function provided by these components.

Function should be named by method name + underscore + what thay do, e.g.: get_feed_links or post_new_link

Things that are persisted in redis and need special care

votes (there's load_votes function in scripts in case the votes need to be re-fetched)
bans

Instalation

Instalation:

Install python3.6
Clone the project
Install pip
Install requirements
Install redis (how to)

docker-compose dev-setup

docker-compose up
docker-compose exec postgres /bin/sh -c "echo create database newz | psql -U postgres"
docker-compose exec news sh -c "cd news && orator migrate"

Tech stack

PostgreSQL
Python3.6 (Flask)
Gunicorn
Redis - Info here
Apache Solr - Info here
StatsD - Info here, Python Client
Graphite - Info here
Sentry - Info here
Administration - https://cockpit-project.org/
AWS s3 - Needs to be configured before start. for feed logos

Kube CSS Configuring PostgreSQL

TODO list

SEO, head optimization
cache all simple relationships
check that we save to redis only the things we need to save
ban user completely when he has too many bans

Cool TODOSs

add site-local articles instead of long texts
add feed sources -> post articles from other rss feeds automatically on this feed

jannishuebl/newz