Skip to content

Commit

Permalink
Merge commit '245804c3fa10608809ad3167194f5ae684913f93' into issue/re…
Browse files Browse the repository at this point in the history
…adme
  • Loading branch information
peterdudfield committed Jan 3, 2025
2 parents 36c87cb + 245804c commit 5bb9543
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
[![All Contributors](https://img.shields.io/badge/all_contributors-15-orange.svg?style=flat-square)](#contributors-)
<!-- ALL-CONTRIBUTORS-BADGE:END -->

[![tags badge](https://img.shields.io/github/v/tag/openclimatefix/uk-pv-national-gsp-api?include_prereleases&sort=semver&color=FFAC5F)](https://github.com/openclimatefix/uk-pv-national-gsp-api/tags)
[![ease of contribution: medium](https://img.shields.io/badge/ease%20of%20contribution:%20medium-f4900c)](https://github.com/openclimatefix#how-easy-is-it-to-get-involved)
[![Test Docker image](https://github.com/openclimatefix/uk-pv-national-gsp-api/actions/workflows/test-docker.yaml/badge.svg)](https://github.com/openclimatefix/uk-pv-national-gsp-api/actions/workflows/test-docker.yaml)

API for hosting nowcasting solar predictions. This is for GSP and National forecasts in the UK.
API for hosting nowcasting solar predictions. This is for GSP and National forecasts in the UK.

We use [FastAPI](https://fastapi.tiangolo.com/).

Expand Down Expand Up @@ -38,7 +38,7 @@ Note you will need a database set up at `DB_URL`. This should use the datamodel

## Documentation

Live documentation can be viewed at `https://api.quartz.solar/docs` or `https://api.quartz.solar/swagger`.
Live documentation can be viewed at `https://api.quartz.solar/docs` or `https://api.quartz.solar/swagger`.
This is automatically generated from the code.

## Development
Expand All @@ -61,9 +61,9 @@ pip install -r requirements.txt
cd src && uvicorn main:app --reload
```

Warning:
If you don't have a local database set up, you can leave the `DB_URL` string empty (default not set)
and set `FAKE=True` and the API will return fake data. This is a work in progress,
Warning:
If you don't have a local database set up, you can leave the `DB_URL` string empty (default not set)
and set `FAKE=True` and the API will return fake data. This is a work in progress,
so some routes might be need to be updated

### Docker
Expand Down

0 comments on commit 5bb9543

Please sign in to comment.