Improve repository documentation and GitHub metadata

Author: niranjanxprt

README.md

@@ -0,0 +1,74 @@
+# Pythonfast
+
+Energy-focused FastAPI learning repository with a React tutorial frontend and FastAPI backend examples.
+
+## Live Links
+
+- GitHub Pages (tutorial app): https://niranjanxprt.github.io/Pythonfast/
+- Repository: https://github.com/niranjanxprt/Pythonfast
+
+## Repository Layout
+
+```text
+.
+├── fastapi-tutorial/      # React + Vite interactive FastAPI tutorial (deployed to GitHub Pages)
+├── my-fastapi-app/        # FastAPI example backend and Pydantic models
+└── .github/workflows/     # CI/CD workflows (Pages deployment)
+```
+
+## What This Repo Includes
+
+- FastAPI basics: routing, request validation, query/path params
+- Pydantic models and validation patterns
+- Energy-domain examples (panels, readings, monitoring)
+- Pandas and NumPy examples for energy data analysis
+- React tutorial UI deployed to GitHub Pages
+
+## Quick Start
+
+### 1. Frontend tutorial app
+
+```bash
+cd fastapi-tutorial
+npm ci
+npm run dev
+```
+
+Open: http://localhost:5173
+
+### 2. FastAPI backend examples
+
+```bash
+cd my-fastapi-app
+python -m venv .venv
+source .venv/bin/activate  # Windows: .venv\Scripts\activate
+pip install fastapi "uvicorn[standard]"
+uvicorn main:app --reload
+```
+
+Open:
+
+- API root: http://127.0.0.1:8000
+- Swagger UI: http://127.0.0.1:8000/docs
+
+## Deployment
+
+The frontend is deployed automatically with GitHub Actions:
+
+- Workflow: `.github/workflows/deploy-fastapi-tutorial-pages.yml`
+- Trigger: push to `main` for files under `fastapi-tutorial/**`
+- Publish target: `gh-pages` branch
+- Vite base path: `/Pythonfast/`
+
+## Best Practices Followed
+
+- Keep frontend and backend concerns separated by directory.
+- Deploy only static frontend assets to Pages; keep API runtime separate.
+- Use lockfiles (`package-lock.json`) for reproducible frontend builds.
+- Use CI/CD workflow for repeatable deployment on every push.
+- Keep secrets out of source code and use environment variables in real deployments.
+
+## Notes
+
+- This repository is tutorial-oriented and optimized for learning.
+- For production APIs, add authentication, persistent storage, tests, and observability.

fastapi-tutorial/README.md

@@ -1,23 +1,36 @@
-# React + Vite
+# FastAPI Tutorial Frontend
 
-This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
+Interactive React + Vite frontend for learning FastAPI with energy-data examples.
 
-Currently, two official plugins are available:
+## Live URL
 
-- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react) uses [Babel](https://babeljs.io/) (or [oxc](https://oxc.rs) when used in [rolldown-vite](https://vite.dev/guide/rolldown)) for Fast Refresh
-- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
+- https://niranjanxprt.github.io/Pythonfast/
 
-## React Compiler
+## Local Development
 
-The React Compiler is not enabled on this template because of its impact on dev & build performances. To add it, see [this documentation](https://react.dev/learn/react-compiler/installation).
+```bash
+npm ci
+npm run dev
+```
 
-## Expanding the ESLint configuration
+Open: http://localhost:5173
 
-If you are developing a production application, we recommend using TypeScript with type-aware lint rules enabled. Check out the [TS template](https://github.com/vitejs/vite/tree/main/packages/create-vite/template-react-ts) for information on how to integrate TypeScript and [`typescript-eslint`](https://typescript-eslint.io) in your project.
+## Production Build
 
-## GitHub Pages
+```bash
+npm run build
+npm run preview
+```
 
-This app is configured for GitHub Pages deployment from the repository root workflow.
+## Deployment Notes
 
-- Live URL: https://niranjanxprt.github.io/Pythonfast/
-- Build base path: `/Pythonfast/`
+- This app is deployed via repository workflow:
+  - `.github/workflows/deploy-fastapi-tutorial-pages.yml`
+- GitHub Pages project URL requires Vite base path:
+  - `base: "/Pythonfast/"`
+
+## Best-Practice Notes
+
+- Keep static docs/tutorial UI on Pages and backend API runtime separate.
+- Use `npm ci` in CI for deterministic installs from `package-lock.json`.
+- Use path-based workflow triggers to deploy only when frontend-related files change.