davewalker5/shippingrecordermvc repository overview

⁠shippingrecordermvc

The ShippingRecorder⁠ GitHub project implements a REST service and associated web-based UI for a SQL-based marine vessel sightings logbook, providing facilities for recording and querying the following data:

• Vessel type and registration details
• Operator, port, country and voyage details
• Sighting locations
• Vessel sightings

The shippingrecordermvc image contains a build of the UI and is intended to be run as a pair with the associated web service.

⁠Getting Started

⁠Prerequisities

In order to run this image you'll need docker installed.

• Windows⁠
• OS X⁠
• Linux⁠

⁠Usage

⁠Service Container Parameters

An instance of the shippingrecorderapisqlite image must be started first in order for the UI to work. The recommended parameters are:

The "/local" path given to the -v argument is described, below, and should be replaced with a value appropriate for the host running the container.

The "--name" parameter is mandatory as the service URL is held in the application settings for the UI image and is expected to be:

http://shippingrecorderservice:80⁠

⁠UI Container Parameters

The following "docker run" parameters are recommended when running the shippingrecordermvc image:

For example:

docker run -d -p 5001:80 --rm --link shippingrecorderservice davewalker5/shippingrecordermvc:latest

The port number "5001" can be replaced with any available port on the host.

⁠Volumes

The description of the container parameters, above, specifies that a folder containing the SQLite database file for the Shipping Recorder is mounted in the running container, using the "-v" parameter.

That folder should contain a SQLite database that has been created using the instructions in the Shipping Recorder wiki⁠.

Specifically, the following should be done:

• SQLite Database Configuration⁠

The folder containing the "shippingrecorder.db" file can then be passed to the "docker run" command using the "-v" parameter.

⁠Running the Image

To run the images for the service and UI, enter the following commands, substituting "/local" for the host folder containing the SQLite database, as described:

docker run -d -v  /local:/var/opt/shippingrecorder.api/ --name shippingrecorderservice --rm  davewalker5/shippingrecorderapisqlite:latest
docker run -d -p 5001:80 --rm --link shippingrecorderservice davewalker5/shippingrecordermvc:latest

Once the container is running, browse to the following URL on the host:

http://localhost:5001⁠

You should see the login page for the UI.

⁠Find Us

• ShippingRecorder on GitHub⁠

⁠Versioning

For the versions available, see the tags on this repository⁠.

⁠Authors

• Dave Walker - Initial work

See also the list of contributors⁠ who participated in this project.

⁠License

This project is licensed under the MIT License - see the LICENSE⁠ file for details.