Add example site.

README.md

@@ -8,30 +8,24 @@ Financier is a comprehensive business management platform built on top of [Utopi
 
 ## Installation
 
-Install the ruby gem as follows:
-
-	git clone https://github.com/oriontransfer/financier.git
-	cd financier
-	bundle install
+Copy the `example/` directory which contains the bare framework for running the application.
 
 ## Usage
 
-To create a user:
+First, create an admin user:
 
-	$ rake financier:users:create
-	Login name: admin
-	Login password: ••••••
+```
+bundle install
+bake financier:user:create
+```
 
-Then, to start the development server:
+Then start the site:
 
-	$ rake
-	* Version 3.8.2 (ruby 2.4.0-p0), codename: Sassy Salamander
-	* Min threads: 0, max threads: 16
-	* Environment: development
-	* Listening on tcp://0.0.0.0:9292
-	* Starting control server on tcp://0.0.0.0:9293
+```
+falcon serve
+```
 
-You can now open <http://localhost:9292> in your browser and log in.
+Visit <https://localhost:9292> to log in.
 
 ## License
 

example/Guardfile

@@ -0,0 +1,10 @@
+
+group :development do
+	guard :falcon, port: 9292 do
+		watch('Gemfile.lock')
+		watch('config.ru')
+		watch(%r{^config/.*})
+
+		notification :off
+	end
+end

example/bake.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+def environment
+	require_relative 'config/environment'
+end
+
+# Prepare the application for start/restart.
+def deploy
+	# This task is typiclly run after the site is updated but before the server is restarted.
+end
+
+# Restart the application server.
+def restart
+	call 'falcon:supervisor:restart'
+end
+
+# Start the development server.
+def default
+	call 'utopia:development'
+end

example/config.ru

@@ -0,0 +1,8 @@
+#!/usr/bin/env rackup
+# frozen_string_literal: true
+
+require_relative 'config/environment'
+
+require 'financier/middleware'
+
+Financier::Middleware.call(self, utopia: UTOPIA)

example/config/README.md

@@ -0,0 +1,7 @@
+# Utopia Config
+
+This directory contains `environment.rb` which is used to initialize the running environment for tasks and servers.
+
+## Setting Environment Variables
+
+If you wish to set environment variables on a per-deployment basis, you can do so by creating an `config/environment.yaml` and populating it with key-value pairs.

example/config/environment.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+Bundler.setup
+
+require 'utopia/setup'
+UTOPIA ||= Utopia.setup
+
+require_relative '../db/environment'
+
+require 'financier'
+require 'json'
+
+require 'time/zone'

example/config/environment.yaml

@@ -0,0 +1,2 @@
+---
+UTOPIA_SESSION_SECRET: example

example/db/environment.rb

@@ -0,0 +1,11 @@
+
+require 'variant'
+require 'relaxo'
+require 'console'
+
+module Financier
+	DATABASE_PATH = File.join(__dir__, Variant.for(:database).to_s)
+
+	# Configure the database connection:
+	DB = Relaxo.connect(DATABASE_PATH, logger: Console.logger)
+end

example/falcon.rb

@@ -0,0 +1,9 @@
+#!/usr/bin/env -S falcon host
+# frozen_string_literal: true
+
+load :rack, :lets_encrypt_tls, :supervisor
+
+hostname = File.basename(__dir__)
+rack hostname, :lets_encrypt_tls
+
+supervisor

example/gems.locked

@@ -0,0 +1,191 @@
+PATH
+  remote: ..
+  specs:
+    financier (0.1.0)
+      bcrypt (~> 3.0)
+      latinum (~> 1.3)
+      markly
+      ofx (~> 0.3)
+      periodical (~> 1.0)
+      qif (~> 1.1)
+      relaxo (~> 1.3)
+      relaxo-model (~> 0.19)
+      time-zone (~> 1.1)
+      trenni-formatters
+      trenni-sanitize
+      tty-prompt
+      utopia (~> 2.18)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    async (1.30.1)
+      console (~> 1.10)
+      nio4r (~> 2.3)
+      timers (~> 4.1)
+    async-container (0.16.12)
+      async
+      async-io
+    async-http (0.56.5)
+      async (>= 1.25)
+      async-io (>= 1.28)
+      async-pool (>= 0.2)
+      protocol-http (~> 0.22.0)
+      protocol-http1 (~> 0.14.0)
+      protocol-http2 (~> 0.14.0)
+    async-http-cache (0.4.2)
+      async-http (~> 0.56)
+    async-io (1.32.2)
+      async
+    async-pool (0.3.8)
+      async (>= 1.25)
+    bake (0.16.1)
+      samovar (~> 2.1)
+    bcrypt (3.1.16)
+    build-environment (1.13.0)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.9)
+    console (1.13.1)
+      fiber-local
+    falcon (0.39.2)
+      async
+      async-container (~> 0.16.0)
+      async-http (~> 0.56.0)
+      async-http-cache (~> 0.4.0)
+      async-io (~> 1.22)
+      build-environment (~> 1.13)
+      bundler
+      localhost (~> 1.1)
+      process-metrics (~> 0.2.0)
+      rack (>= 1.0)
+      samovar (~> 2.1)
+    ffi (1.15.4)
+    fiber-local (1.0.0)
+    formatador (0.3.0)
+    guard (2.18.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.13.0)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-falcon (0.12.1)
+      async-container (~> 0.16.0)
+      falcon (~> 0.35)
+      guard
+      guard-compat (~> 1.2)
+    http-accept (2.1.1)
+    latinum (1.7.1)
+    listen (3.7.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    localhost (1.1.8)
+    lumberjack (1.2.8)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    mapping (1.1.1)
+    markly (0.6.1)
+    method_source (1.0.0)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2021.0901)
+    mini_mime (1.1.1)
+    mini_portile2 (2.6.1)
+    msgpack (1.4.2)
+    nenv (0.3.0)
+    nio4r (2.5.8)
+    nokogiri (1.12.4)
+      mini_portile2 (~> 2.6.1)
+      racc (~> 1.4)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    ofx (0.3.2)
+      nokogiri
+    pastel (0.8.0)
+      tty-color (~> 0.5)
+    periodical (1.2.0)
+    process-metrics (0.2.1)
+      console (~> 1.8)
+      samovar (~> 2.1)
+    protocol-hpack (1.4.2)
+    protocol-http (0.22.5)
+    protocol-http1 (0.14.2)
+      protocol-http (~> 0.22)
+    protocol-http2 (0.14.2)
+      protocol-hpack (~> 1.4)
+      protocol-http (~> 0.18)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    qif (1.2.0)
+    racc (1.5.2)
+    rack (2.2.3)
+    rake (13.0.6)
+    rake-compiler (1.1.1)
+      rake
+    rb-fsevent (0.11.0)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    relaxo (1.6.2)
+      console
+      rugged
+    relaxo-model (0.19.0)
+      msgpack (~> 1.0)
+      relaxo (~> 1.5)
+    rugged (1.1.1)
+    samovar (2.1.4)
+      console (~> 1.0)
+      mapping (~> 1.0)
+    shellany (0.0.1)
+    thor (1.1.0)
+    thread-local (1.1.0)
+    time-zone (1.2.0)
+    timers (4.3.3)
+    trenni (3.13.1)
+      rake-compiler
+    trenni-formatters (2.13.1)
+      mapping (~> 1.1)
+      trenni (~> 3.12)
+    trenni-sanitize (0.6.1)
+      trenni (~> 3.5)
+    tty-color (0.6.0)
+    tty-cursor (0.7.1)
+    tty-prompt (0.23.1)
+      pastel (~> 0.8)
+      tty-reader (~> 0.8)
+    tty-reader (0.9.0)
+      tty-cursor (~> 0.7)
+      tty-screen (~> 0.8)
+      wisper (~> 2.0)
+    tty-screen (0.8.1)
+    utopia (2.18.5)
+      concurrent-ruby (~> 1.0)
+      console (~> 1.0)
+      http-accept (~> 2.1)
+      mail (~> 2.6)
+      mime-types (~> 3.0)
+      msgpack
+      rack (~> 2.2)
+      samovar (~> 2.1)
+      trenni (~> 3.0)
+      variant (~> 0.1)
+    variant (0.1.1)
+      thread-local
+    wisper (2.0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bake
+  falcon
+  financier!
+  guard
+  guard-falcon
+
+BUNDLED WITH
+   2.2.22

example/gems.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+group :preload do
+	gem "bake"
+
+	gem "financier", git: "https://github.com/oriontransfer/financier"
+	# gem "financier", path: "../"
+end
+
+group :production do
+	gem 'falcon'
+end
+
+group :development do
+	gem 'guard'
+	gem 'guard-falcon'
+end