Carafe

Packages

See https://soliantconsulting.github.io/carafe/

Quickstart

Copy Carafe infrastructure into your solution
- Two tables
- One custom function
- One folder of scripts
Run Carafe Initialize script
Create a Web Viewer
Paste the following expression into your Web Viewer
- TEH CODEZ
Define a JSON data source that matches one of the provided example formats

Ta-dah!

Basic Implementer Documentation

Explanation of carafeData var
Working with JSFiddle
Creating your own sample data in JSFiddle
- e.g.: carafeData = [["Garrett Winters", "Accountant", "Tokyo", "8422", "2011/07/25", "$170,750"],];
Implementing custom HTML
Implementing JavaScript adjustments
Implementing CSS adjustments

Advanced Implementer Documentation

Advanced use of carafeData var
FM WebViewer Bridge

Package Development

To run the project in development, you need to have Docker and Docker Compose installed.

Development Quick Start (See devrefresh for more info)

Shorthand Development Environment Refresh
- Runs a subset of above commands to quickly refresh dev after changes have been made.
  - ./bin/devrefresh.sh
- To force all the Docker images to update, you can run it with the --hard switch
  - ./bin/devrefresh.sh --hard

You can now preview all the Carafe packages at http://0.0.0.0:8000.

Docker Development Environment

This application is running on a stock apache2/php7.2 Docker container. PHP dependencies are managed with Composer in /composer.json. JavaScript and CSS dependencies are managed with NPM in /package.json.

Developing in the /carafe-packages-src directory

While working on Carafe packages, you generally have to call webpack after every edit. Instead you can run the following command, which will watch the directory for changes and rebuild when required:

docker-compose run --rm build webpack --mode development --watch

Development changes are output to public, so you can preview them in the development environment by refreshing http://0.0.0.0:8000 in your browser.

Publishing Packages

When a package is ready to be released, run webpack in mode production to minify js and css files and deploy to /carafe-package. Then run the php helper script to generate a new index.html page and update the code to build the JS Fiddle links.

docker-compose run --rm build webpack --mode production ; docker-compose run --rm web composer build-index

jeremiahsmall/carafe