openclimatefix / open-source-quartz-solar-forecast

Open Source Solar Site Level Forecast
MIT License
69 stars 55 forks source link

add dashboard #146

Closed sicunchen closed 4 months ago

sicunchen commented 4 months ago

Pull Request

Description

My attempt at #131 and #133 . I used fastapi for the backend and react (shadcn/ui) for the dashboard. I also added some simple validation for the inputs.

How Has This Been Tested?

https://github.com/user-attachments/assets/1debaf0e-61b4-4b7f-876d-5499c58aecad

If your changes affect data processing, have you plotted any changes? i.e. have you done a quick sanity check?

Checklist:

sicunchen commented 4 months ago

To see the dashboard locally, first start the api: cd backend. python main.py. backend will be running at localhost:8000.

Running the frontend: cd frontend. npm run dev frontend will be running at localhost:5137

peterdudfield commented 4 months ago

Thank you so much for this, really appreciate you doing this. Great video

Could you add the instruction on how to run the api and app into a new section in the readme?

sicunchen commented 4 months ago

I added the instruction and reverted the notebook change

Clemo97 commented 4 months ago

@sicunchen since you've already built the API how about adding a schema and docs for it?

peterdudfield commented 4 months ago

@sicunchen since you've already built the API how about adding a schema and docs for it?

Thats a great suggestion. After #149 is merged we should definately do this. Ive put this in here #150

peterdudfield commented 4 months ago

@all-contributors please add @sicunchen for code

allcontributors[bot] commented 4 months ago

@peterdudfield

I've put up a pull request to add @sicunchen! :tada:

peterdudfield commented 4 months ago

hey @sicunchen do you fancy putting the video you made in the readme.md here?