diff --git a/frontend/README.md b/frontend/README.md index d6af7e3..9f85d89 100644 --- a/frontend/README.md +++ b/frontend/README.md @@ -1,32 +1,23 @@ -# React + TypeScript + Vite - -This template provides a minimal setup to get React working in Vite with HMR and some Oxlint rules. - -Currently, two official plugins are available: - -- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react) uses [Oxc](https://oxc.rs) -- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react-swc) uses [SWC](https://swc.rs/) - -## React Compiler - -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). - -## Expanding the Oxlint configuration - -If you are developing a production application, we recommend enabling type-aware lint rules by installing `oxlint-tsgolint` and editing `.oxlintrc.json`: - -```json -{ - "$schema": "./node_modules/oxlint/configuration_schema.json", - "plugins": ["react", "typescript", "oxc"], - "options": { - "typeAware": true - }, - "rules": { - "react/rules-of-hooks": "error", - "react/only-export-components": ["warn", { "allowConstantExport": true }] - } -} -``` - -See the [Oxlint rules documentation](https://oxc.rs/docs/guide/usage/linter/rules) for the full list of rules and categories. +# 📬 InboxOS Frontend — React Client Dashboard + +This is the frontend dashboard client for **InboxOS — The AI Inbox Operating System**. + +## Stack +- **Framework**: React 19 + TypeScript +- **Build Tool**: Vite +- **Styling**: Tailwind CSS +- **State & Queries**: TanStack React Query +- **Routing**: React Router DOM + +## Development Setup + +1. Copy `.env.example` to `.env` and configure your API URL. +2. Run `npm install` from the workspace root. +3. Start the dev server: + ```bash + npm run dev + ``` +4. Build for production: + ```bash + npm run build + ``` diff --git a/frontend/public/favicon.svg b/frontend/public/favicon.svg index 6893eb1..bc1b9f2 100644 --- a/frontend/public/favicon.svg +++ b/frontend/public/favicon.svg @@ -1 +1,8 @@ - \ No newline at end of file + + + + + + + + \ No newline at end of file diff --git a/frontend/src/assets/vite.svg b/frontend/src/assets/vite.svg index 5101b67..a429103 100644 --- a/frontend/src/assets/vite.svg +++ b/frontend/src/assets/vite.svg @@ -1 +1,8 @@ -Vite + + + + + + + + diff --git a/frontend/src/components/LandingPage.tsx b/frontend/src/components/LandingPage.tsx index daa853f..b40a5cc 100644 --- a/frontend/src/components/LandingPage.tsx +++ b/frontend/src/components/LandingPage.tsx @@ -1870,9 +1870,9 @@ export const LandingPage: React.FC = () => {
📁 - web/ + frontend/ - (Next.js / Vite dashboard) + (React client dashboard)