afai97202013/forum repository overview

⁠demo-forum

Stackoverflow-like app

People can ask questions and share their experiences on the platform.

⁠Feature

Now

• Users register their accounts by their emails.
• Basic user authentication. Users can recover their passwords if they forget ones.
• Basic profiles. Upload users' favorite pictures.
• Users can create threads.
• Users can write comments to threads.
• Admin can disable a comment if users write something bad.

Future

• The author of the thread can choose the comment he thinks it's useful.
• User can like and dislike a comment or a thread.
• User can reply to a comment.
• User can receive notifications if their threads get a comment.
• Admin Dashboard.
• Track users' activities.
• Admin can block the user if the user misbehaves.

I would like to add more features to the app. But it depends on my free time and energy.

⁠Installation

Use docker-compose or install on Unix systems.

⁠Environment variables

Here is an example configuration. You can change PostgreSQL to MySQL or MariaDB.

• Basic

  • FLASK_APP=forum.py - application
  • FLASK_CONFIG=docker - configuration settings
  • SECRET_KEY=secret - secret key, please use safe one.
  • DATABASE_URL=postgresql+psycopg2://db_user:db_password@db:5432/db - database settings
  • [email protected] - admin user
  • FORUM_PASSWORD=admin_password - admin password

• Mail Server (Mailtrap, or other SMTP services)

  • MAIL_SERVER
  • MAIL_PORT
  • MAIL_USE_TLS
  • MAIL_USERNAME
  • MAIL_PASSWORD

• Database (PostgreSQL)

  • POSTGRES_DB
  • POSTGRES_USER
  • POSTGRES_PASSWORD

• Default path for user avatars

  • /forum/app/static/uploads/

• Message Queue and Celery

  • CELERY_BROKER_URL
  • CELERY_RESULT_BACKEND

• Session Storage

  • SESSION_HOST
  • SESSION_PORT
  • SESSION_DB

• Cache

  • CACHE_REDIS_URL

The broker, session storage and cache are Redis.