Skip to content

jshwi/jss

Repository files navigation

jss

License Build CodeQL pre-commit.ci status codecov.io readthedocs.org python3.8 Black isort docformatter prettier pylint Security Status Known Vulnerabilities

A Flask webapp

Install

  $ docker compose build

Development

http://localhost:5000

  $ npm run init:dev
  $ docker compose up dev

Production

https://localhost:443

  $ docker compose up production

Documentation

  • Source documentation here

Features

Progressive Web Application

  • Mobile support
  • Installable as a standalone app

User Accounts

  • Single admin user (Can only be created by root user via the commandline)
    • Access to site configuration
      • change favicon
    • Access to UI for viewing database
  • Signing up
    • Email verification
  • Log in
    • Password reset functionality
  • Logged in (including admin)
    • Editable user profiles
    • Functionality to follow other users
    • Functionality to message other users
    • Allow changing of username (while still being able to find user by old username)

Blog Posts

  • CREATE, READ, UPDATE, DELETE, or "CRUD"
  • Posting, updating, and deleting posts restricted to authorized users
  • All posts are timestamped
  • Markdown support with syntax highlighting (see list of languages here)
  • Pagination support
  • Support for versioning and rolling back changes

Configurable

  • Toggle dark mode

Translation

  • See list of languages here

Integrations

  • Stripe payment option
  • Gravatar for user avatars

Error handling

  • Support for emailing errors