wathne / dat310-2023-examproject

You will need Python 3.11 and Flask.

pip install --user flask

I prefer to use pip with the "--user" flag. It may be necessary to add flask to the system $PATH. (Linux: Prepend ~/.local/bin to $PATH.)

How to run:

git clone https://github.com/wathne/dat310-2023-examproject.git
cd dat310-2023-examproject
python app.py
firefox http://localhost:5000/

Rough overview:

• Project report | 5 |
• Log in works | 3 |
• Register user | 3 |
• JS Form validation | 5 |
  • (See /static/form-validation.js)
• Sort or search possible | 3 |
  • (search/sort/filter ascending/descending by date/subject/text/image/user)
• Sort or search stored | 4 |
  • (Settings stored as json in SecureCookieSession.)
• Update, delete working | 3 |
• AJAX request used | 3 |
• Fluid layout | 5 |
• Absolute used | 2 |
  • (absolute and z-index used by text background in footer.)
• Flex used | 2 |
• Semantic tags | 2 |
• Phone layout (bootstrap) | 5 |
  • (800px width looks ok.)
• Layout extra | 3 |
  • (Sticky footer and probably something else.)
• Components | 5 |
• Data stored, updated, deleted | 6 |
• Rest API | 6 |
• Server side validation | 5 |
• Errors displayed | 5 |
• Authentication | 5 |
• Access control | 5 |
  • (User groups, only moderator/admin can modify/delete threads.)
• Extra feature | 15 |
  • (Images, dates and probably something else.)

Dev stuff:

Google style guides:

• https://google.github.io/styleguide/pyguide.html (strict)
• https://google.github.io/styleguide/jsguide.html (optional)
• https://google.github.io/styleguide/htmlcssguide.html (optional)

Commit convention:

• https://www.conventionalcommits.org/en/v1.0.0/ (optional)
• https://github.com/conventional-changelog/commitlint (optional)

How to install all devDependencies listed in package.json (optional):

cd dat310-2023-examproject
npm install

This will install commitlint and husky git hook. The husky git hook should work on both Linux and Mac, maybe not on Windows.

How to install and run pylint and mypy (optional):

pip install --user pylint
pip install --user mypy
cd dat310-2023-examproject
pylint
mypy

I prefer to use pip with the "--user" flag. It may be necessary to add pylint and mypy to the system $PATH. (Linux: Prepend ~/.local/bin to $PATH.)