https://github.com/opusvl/fb11-demo

https://github.com/opusvl/fb11-demo

Last synced: 11 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/opusvl/fb11-demo
• Owner: OpusVL
• License: other
• Created: 2018-02-06T16:16:32.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2019-09-18T08:37:44.000Z (over 6 years ago)
• Last Synced: 2025-03-13T22:11:29.775Z (over 1 year ago)
• Language: Perl
• Size: 11.7 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: Changes
  • License: LICENSE

Awesome Lists containing this project

README

          
# FB11::Demo

This small demo app was made to show off FB11's features and also as a test bed

against which changes to FB11 could be exhibited without the obfuscating content

of client work.

## Creation

This app was created with the following simple commands:

    dzil new -P FB11 FB11::Demo

    cd FB11-Demo

    dzil add -P FB11 -p FB11X FB11::Demo::FB11X::Admin

The first line minted the main application, and the third added an FB11X

component. It is not strictly necessary to call this FB11X, but the convention

is helpful.

Obviously this only created a skeleton; the rest of the work was done manually.

# Running

You can plackup the PSGI file and go nuts. Remember to install dependencies:

there's a `cpanfile` for that.

    cpanm --installdeps .

    plackup -I lib -p 12345 fb11-demo.psgi

It's a Catalyst app so you can configure it yourself. You'll need a postgres

database. See below for database setup.

## Docker

I have dockerised this application. There is a Makefile here. You should use

that.

    make docker

    docker-compose up -d

You should also copy the `docker-compose.override.yml.example` to

`docker-compose.override.yml` and amend it to suit your needs. Your most likely

use of this is to add a port to localhost that will serve your app.

To serve it on `localhost:12345`:

    ...

    app:

      ports:

        - "12345:5000"

Remember to run `docker-compose up -d` whenever you make changes to this YAML

file. Remember not to make changes to the base YAML file.

### Developing

You can make changes to the checked-out code using volumes and environment

variables. The example `docker-compose.override.yml.example` file contains

configuration that will mount your code into the container and add it to

`PERL5LIB`. Whenever you change your code in this situation, you will want to

restart the container

    docker-compose restart app

# Database

There's magic that sets up the database. It's in OpusVL::FB11, which you

installed as a dependency, or which you have because you're using docker.

    fb11-dbh -C Model::FB11AuthDB -t 1 OpusVL::FB11::Schema::FB11AuthDB deploy

    fb11-dbh -C Model::FB11AuthDB OpusVL::FB11::Schema::FB11AuthDB upgrade

If you're using docker you can just put `docker-compose exec app` in front of

each command to run it within the container.

In future we shall make this be done via the application itself.

## Docker

The docker setup by default stores your postgres data in the directory `pgdata`.

We use a volume so that if you have to recreate this container, you don't lose

all the stuff you've done within the app.  You can override this in your

override file simply by providing a new value for the `volumes` array, like in

the example overrides file.