davewalker5/shippingrecorderapisqlite repository overview

⁠shippingrecorderapisqlite

The ShippingRecorder⁠ GitHub project implements a REST service and associated web-based UI for a SQL-based maritime 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 shippingrecorderapisqlite image contains a build of the logic and REST service for a SQLite database.

⁠Getting Started

⁠Prerequisities

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

• Windows⁠
• OS X⁠
• Linux⁠

⁠Usage

⁠Container Parameters

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

For example:

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

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.

Similarly, 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 Shiping Recorder database 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 Shiping 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 image, enter the following command, substituting "/local" for the host folder containing the SQLite database:

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

⁠Documentation

The API implements Swagger in the development environment. To see the documentation, checkout the code from GitHub, run the API from that working copy and browse to the following URL:

https://localhost:5001/swagger/index.html⁠

Replace "5001" with whatever port number the API is listening on.

⁠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.