README.md

Snorlogue

Easy to use, allows you to snooze

Snorlogue is a prologue extension, that provides a set of simple CRUD routes to administrate your database. It makes use of norm models to figure out which columns a given table has and how to best represent them.

• Documentation (built with nimibook)
• API index

Installation

Install Snorlogue with Nimble:

$ nimble install -y snorlogue

Add Snorlogue to your .nimble file:

requires "snorlogue"

Finally, copy the resources folder from the snorlogue package into your project directory. It contains the HTML templates for the various admin pages. This will likely not be necessary in future versions of Snorlogue.

cp -r <NIMBLE_DIRECTORY>/pkgs/snorlogue-X.X.X/snorlogue/resources <YOUR_PROJECT_DIRECTORY>/src

Feature-Scope Overview

Snorlogue provides the following pages:

• Table Overview - Shows all registered Model-types and their corresponding SQL tables
• SQL - Enables direct interaction with the database. Only allows DML-SQL, not DDL-SQL.
• About - Displays configs and routes of your prologue application in general
• Model Table Overview - Shows all entries of a given Model in a paginated list
• Model CRUD pages - Pages enabling Create/Update/Delete interaction with individual Model entries

Example Screenshots

Table Overview Page

SQL Page

About Application Page

Model Table Overview Page

Create Model Page

Update Model Page

Running Tests

Clone the repository. Make sure you have docker and docker-compose installed (this is necessary as all tests run in a container) and a running internet connection.

$ nimble sqliteTests        # Runs the entire test-suite using an sqlite database
$ nimble postgresTests      # Runs the entire test-suite using a postgres database container