CovenantForum

module
Version: v0.0.0-...-8405ca7 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 15, 2019 License: MIT

README

CovenantForum is a simple decentralized forum web app powered by CovenantSQL.

Decentralized forum?

  • Data and files are saved in decentralized database. Anyone with a permission granted private key and the DSN(Database Serial Num) can serve the forum anywhere.
  • Also, all posts related data are saved on an unique SQLChain Block like this.
  • Anyone can create your "blockchain powered forum" with just few steps.

Twitter Bot

  • @iBlockPin will record your tweet to CovenantForum and the Blockchain.

Features

  • Static files and database are powered by decentralized database: CovenantSQL.
  • REST API backend written in Go
  • Vue.js-based frontend
  • Social login (OAuth 2.0) via three providers:
    • Google
    • Facebook
    • Github
  • JSON Web Tokens (JWT) are used for user authentication in the API
  • Single binary deploy. All the static assets (frontend JavaScript & CSS files) are embedded into the binary
  • Markdown comments
  • Avatar upload, including animated GIFs. Auto-generated letter-avatars on user creation

Arch

Comparison between Traditional and Decentralized forum:

Demo

Demo forum

Quick Start

Just one command to start a mirror of Demo forum

$ go get -u github.com/CovenantSQL/CovenantForum/cmd/forum && \
    cd $GOPATH/src/github.com/CovenantSQL/CovenantForum/cmd/forum && \
    $GOPATH/bin/forum start

Create your new Forum

  • Generate a CovenantSQL config and keypair.

  • Get PTC by replying to the topic with your wallet address.

  • Create a new empty CovenantSQL database with cql.

  • Obtain OAuth 2.0 credentials (client_id and secret) from at least one of the providers (Google, Facebook, Github) so users can log into the web application. The OAuth callback url will be <base_url>/oauth/end/<provider>. The <base_url> is where the forum web app will be mounted on your site and the <provider> is the lowercase provider name. For example, if base_url is https://my.website.com/forum/, then the oauth callback url for google will be https://my.website.com/forum/oauth/end/google.

  • Download and compile the forum binary:

    $ go get -u github.com/CovenantSQL/CovenantForum/cmd/forum
    
  • Inside an empty directory run:

    $ forum init
    

    This will generate an initial configuration file "forum.conf" inside the current dir. Edit the configuration file to set the server listen address, the base url, the database and file storage parameters, OAuth credentials, etc.

  • Fill in file_storage and store in the forum.conf:

    file_storage {
      type = "covenant_s3"
      covenant_s3 {
        database  = "covenantsql://e08d944b4ebd69e12aa69..."
        config    = "config.yaml"
        masterkey = ""
      }
    }
    
    store {
      type = "covenantsql"
      covenantsql {
        database  = "covenantsql://e08d944b4ebd69e12aa69..."
        config    = "config.yaml"
        masterkey = ""
      }
    }
    
  • Run the following command to start the forum web server.

    $ forum start
    
  • Sign in into your web application using one of the social login providers. Then run the following command to grant admin privileges to your user.

    $ forum add-admin <your-username>
    

Screenshots

Topics

Topics

Comments on blockchain

Comments

Todo

  • Make creating new forum easier.
  • Grant low permission on forum database.
  • We are working on CovenantSQL.

License

  • CovenantForum is derived from a simple traditional forum disintegration/bebop, but CovenantForum has a totally different purpose. So, we just create a new project.

Directories

Path Synopsis
Package api provides an HTTP handler that handles the forum REST API requests.
Package api provides an HTTP handler that handles the forum REST API requests.
Package avatar provides a service that manages forum user avatars.
Package avatar provides a service that manages forum user avatars.
cmd
forum
CovenantSQL is a simple discussion board / forum web application.
CovenantSQL is a simple discussion board / forum web application.
Package config provides the forum configuration file structure, initialization and reading.
Package config provides the forum configuration file structure, initialization and reading.
Package filestorage provides a file storage service that manages public web app files e.g.
Package filestorage provides a file storage service that manages public web app files e.g.
Package jwt provides a service to create and verify JWT auth tokens for the forum web app.
Package jwt provides a service to create and verify JWT auth tokens for the forum web app.
Package oauth provides an HTTP handler to handle OAuth2 redirect and callback requests for the bebop web app.
Package oauth provides an HTTP handler to handle OAuth2 redirect and callback requests for the bebop web app.
Package static provides http handlers for serving static files from the embedded filesystem or from a local directory.
Package static provides http handlers for serving static files from the embedded filesystem or from a local directory.
Package store provides a forum data store interface.
Package store provides a forum data store interface.
covenantsql
Package covenantsql provides a CovenantSQL implementation of the forum data store interface.
Package covenantsql provides a CovenantSQL implementation of the forum data store interface.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL