# QORE

Archival backend providing core set of APIs and administrative pages.


## Running the project locally
To run the project locally, you must have `sbt` installed (version 1.0+).
 `cd` into the root of the project and execute `sbt run`. This would start an `sbt` shell and run the project on the default port. From here on, you can play with the application using `GraphiQL` or any other `GraphQL` compliant application (or by simply using `cUrl`).
  
## GraphQl API usage

A query like such:
```
{
  allCollections {
    id
  },
  collection(id : "f8b405d6-fc4f-4ae8-adeb-7ddb07b758bd") {
    archdesc {
      did {
        id
      }
      archdescoption {
        ... scopeContent
      }
    }
  }
}

fragment scopeContent on scopecontent {
  scopecontentoption {
    ... on p {
      mixed {
        ... on text {
          text
        }
      }
    }
  }
}
```

would result in:
```
{
  "data": {
    "allCollections": [
      {
        "id": "f8b405d6-fc4f-4ae8-adeb-7ddb07b758bd"
      }
    ],
    "collection": {
      "archdesc": {
        "did": {
          "id": null
        },
        "archdescoption": [
          {},
          {
            "scopecontentoption": [
              {
                "mixed": [
                  {
                    "text": "The Lowell Thomas Papers encompasses a wide range of materials documenting the life, family, and professional career of Lowell Thomas. These materials include correspondence, administrative and financial documents, manuscripts, printed materials, photographic materials, motion picture films, audio recordings, and memorabilia."
                  }
                ]
              }
            ]
          },
          {},
          {},
          {}
        ]
      }
    }
  }
}
```
## Contribution | Collaboration
The project board is available at:

https://tree.taiga.io/project/prasoon-qore/timeline


## Caution
This project is under active development and is bound to change rapidly. 