Technical references¶

This is an alphabetical list of tech references. Sometimes we refer to a technology without making use of it in the app, we have marked those entries with an ✗.

References¶

Web design

webApi interacting with the loaded document in a browser

Styling

css cascading stylesheets:
flexbox laying out boxes in flexible ways
hsl color space

html markup language for the web

Shorthands

markdown rich text from plain text
yaml configuration language, as simple as markdown.

Client side

language

javascript scripting language for the web
eslint checks ES6 code against style requirements
prettier code formatter for javascript

Server side

python data-oriented scripting language
flask micro web framework
gunicorn task runner, acting as webserver behind a proxy
wsgi bridge between the python language and webservers

Database

mongodb NO-SQL database, JSON/Javascript based

Generic

bash shell scripting
iso8601 date and time format

Testing

pytest test framework for python, well-suited to Flask
coverage making sure that the tests cover the whole code base

Documentation

mkdocs Static page generator in Python
pdoc3 API-doc generator from Python docstrings
cloc counting lines of code

Editing

✗ IDE Integrated Developer's Environment
✗ Atom IDE by GitHub
✗ SublimeText commercial text editor
vim old-hands text editor, still competes with IDEs
- ALE runs linters and formatters within vim
✗ Visual Studio Code IDE by Microsoft
✗ Webstorm commercial IDE

???+ abstract "Linters and formatters * flake8 code linter for Python * black code formatter for Python