TJMusiitwa/Covid19-Uganda-REST-API

A REST API created with in dart with the Aqueduct framework to provide access to data relating to the Covid-19 pandemic in Uganda # Covid-19 Uganda API A REST/GraphQ API created with Dart with the Aqueduct framework and Hasura, respectively, to provide access to data relating to the Covid-19 pandemic in Uganda Deployed on Heroku with Hasura as the GraphQL as a service framework. _Still very much a work in progress with some small improvements down the road_ REST API URL: ug-covid19-rest-api.herokua… GRAPHQL API URL: covid19-uganda-graph-api.he… _You may explore the GraphQl Endpoint by using any graphql playground of your choice. I suggest the use of GraphQLBin and then just paste in the above GraphQl Endpoint_ ### Documentation The REST API is self-documenting and you can access the OpenAPI documentation from the `/client` endpoint. ## Running the Application Locally Run `aqueduct serve` from this directory to run the application. For running within an IDE, run `bin/main.dart`. By default, a configuration file named `config.yaml` will be used. To generate a SwaggerUI client, run `aqueduct document client`. ## Running Application Tests To run all tests for this application, run the following in this directory: ``` pub run test ``` The default configuration file used when testing is `config.src.yaml`. This file should be checked into version control. It also the template for configuration files used in deployment. ## Deploying an Application See the documentation for Deployment.