Skip to main content

Getting Started

Minerva is designed to be lightweight and easy to use. It is a web service for object storage services. You can use it to store objects in Ali Cloud OSS. You just need to pass your Ali Cloud access credentials to use this service.

caution

Before you start using Minerva, we have to tell you something: We only provides Spring/SpringBoot paradigm, and it is deployed and run as a JAR. So please check whether it meets your needs before using it.

Docker Compose​

With docker compose, you can quickly set up a complete Minerva application by starting two services: web service and database service.

Since build is already included in the docker-compose.yml file, you only need to navigate to Minerva's root directory and execute one command: docker compose up.

When the Minerva application is started successfully, you can upload files to and download the file you need from Ali Cloud OSS as you like. In addition to this, you can also query the metadata information of the file from database.

File Metadata​

Inserting file metadata​

We can insert a file metadata record by specifying the file's unique identifier fileId, the name of the file and the file type.

mutation createMetaData {
    createMetaData(fileId: "fileId123", fileName: "pride-and-prejudice.pdf", fileType: "PDF") {
        fileName,
        fileType
    }
}

Querying file metadata​

We can get the corresponding file metadata by using fileId.

query {
    metaData(fileId: "fileId123") {
        fileType
        fileName
    }
}