Skip to content
Experimental wiki software written in Rails and JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
app
bin
config
lib
log
public
scripts
spec
tmp
vendor
.env.example
.gitignore
.rspec
.ruby-version
FRONTEND_VERSION
Gemfile
Gemfile.lock
LICENCE
Procfile
README.md
Rakefile
app.json
config.ru
package.json

README.md

Brahin Backend

Experimental wiki software written in Rails and JavaScript - central Rails app.

This is an experiment of a modular, progressive enhancement approach to implement a wiki app. You start with a HTML page, that can be viewed without any scripting. The page will contain information about which editor was used to create it, and that editor will be loaded. Every functionality is developed as a separate file, which could theoretically be optional, e.g. linking between pages, single-page-app, storage, tree-navigation, search, etc.

Installation

This is a simple Rails application. It uses file storage in development, Redis in production.

bundle install
bundle exec rails server

Deployment

Deploy

Configuration

Force SSL

Environment variables:

  • FORCE_SSL=1 - force redirection to the https endpoint
  • GITHUB_WEBHOOK_SECRET
  • STORAGE=git|file|redis
  • GIT_SYNC_REMOTE - remote Git url
  • GIT_REPO_DIR - where to store the git repository, default: /data
  • BRAHIN_FRONTEND_URL - default: https://brahin.online/modules
  • BRAHIN_FRONTEND_VERSION - which version of the front-end to load; examples: 0-pre, 0.3-pre, 0.3.1, 0.3.1+e3c7df

Development

The main front-end bits are in public/modules/, not part of the Rails asset pipeline.

The editor module is in the brahin-slate-editor repo.

Licence

MIT - see LICENCE file.

You can’t perform that action at this time.