SchemaCrawler Web Application

Please see the SchemaCrawler website for more details.

Web Application

To access the application, open a browser to https://schemacrawler-webapp.herokuapp.com/

SchemaCrawler Web Application makes SchemaCrawler accessible on the web. You can generate a schema diagram of your SQLite database.

Technologies

This is a Spring Boot web application with a Bootstrap user interface, with source code control in GitHub, which is automatically built on every commit by GitHub Actions using a Maven build, tests are run, and coverage measured with JaCoCo and Codecov.io, and then immediately deployed to Heroku using a Docker image, which generates an crows-foot ERD of a SQLite database.

Build and Run

Build

Install Graphviz, which is a prerequisite for SchemaCrawler
Install Docker
Build application from Maven, run mvn clean package

Build Docker Image

Follow the steps above
Install Docker
Build application and Docker image from Maven, run mvn -Ddocker.skip=false clean package

Start the Server

Set the following environmental variables locally
- AWS_ACCESS_KEY_ID
- AWS_SECRET
- AWS_S3_BUCKET
Do one of the steps below to start the web application locally on your system
- Start the application from Maven, run
  mvn -Dspring-boot.run.fork=false spring-boot:run
- Start application from the jar file, run
  java -jar target/schemacrawler-webapp-16.16.14.3.jar
- Start the application from the local image in a Docker container, run
  docker run -d --rm --env AWS_ACCESS_KEY_ID=xxxxx --env AWS_SECRET=xxxxx --env AWS_S3_BUCKET=xxxxx -p 8080:8080 -t schemacrawler/schemacrawler-webapp

Use the Application

From a Browser

Then, after you ensure that the web server is running, either from the command-line, or the Docker container, open a browser to https://localhost:8080

As an API

You can use the SchemaCrawler Web Application as a REST API. The specifications are on Swagger Hub.

Submit a request and your SQLite database file (say "test.db" in your local directory) with a command like this:

curl \
  -F "name=Sualeh Fatehi" \
  -F "email=sualeh@hotmail.com" \
  -F "file=@test.db" \
  -H "Accept: application/json" \
  http://localhost:8080/diagrams

You will get a 12 character key in return, which uniquely identifies your request.

If your identifier is "l0nk0wu4t2a3", can retrieve the generated image after a few minutes using a request similar to:

curl http://localhost:8080/diagrams/l0nk0wu4t2a3/diagram --output diagram.png

DukeXia / SchemaCrawler-Web-Application