diff --git a/README.md b/README.md index c205e67..d0dc0f7 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,14 @@ # Developer UI for Symphony. -Allow for viewing daily overview of average connections and active rooms over the previous 24 hours. -Data for viewing on custom timeframes, e.g 2 hours between yyyy-mm-dd xx:xx:xx UTC-X and another time could be extended with dashboard modifications +Shows daily overview of average connections and active rooms over the previous 24 hours. ### static room state observation -Allows developer to verify the rooms that have been created, check their storage capacity, and get a JSON representation of all the -Synced Types associated with a given room. +Allows developer to verify the rooms are created, state is updated, and check the size of the room state. ### real-time room state observation -Allows developer view the real-time state of a given room for debugging +Allows developer view the real-time state of a room for debugging. ## Setup -Define env variables - - DOMAIN - - PORT - -Run in dev mode: `npm run dev` -OR +Should not be manually deployed alone, unless for inspection of UI. -Rebuild project `npm run build` -Run `npm start` \ No newline at end of file +Deployment automated through `symphony-cli` npm package. \ No newline at end of file diff --git a/app/components/Navigation.tsx b/app/components/Navigation.tsx index 595fe9d..6fe364b 100644 --- a/app/components/Navigation.tsx +++ b/app/components/Navigation.tsx @@ -1,15 +1,9 @@ export default function Navigation() { return ( ); } diff --git a/app/routes/dashboard/index.tsx b/app/routes/dashboard/index.tsx index 91a45b1..370190f 100644 --- a/app/routes/dashboard/index.tsx +++ b/app/routes/dashboard/index.tsx @@ -15,21 +15,14 @@ const Dashboard = () => { id: 1, title: "Concepts", description: "Learn the concepts of Symphony before getting started", - link: { text: "Learn concepts", href: "#" }, + link: { text: "Learn concepts", href: "https://symphony-framework.github.io" }, }, { id: 2, title: "Get Started", description: "Learn how to auto-deploy and self-host Symphony using our CLI tool", - link: { text: "Get Started", href: "#" }, - }, - { - id: 3, - title: "Examples", - description: - "Browse and take inspiration from our galley of collaborative UI patterns", - link: { text: "Browse Examples", href: "#" }, + link: { text: "Get Started", href: "https://github.com/symphony-framework/symphony-cli" }, }, ]; @@ -48,7 +41,8 @@ const Dashboard = () => { setConnections(connections); setLastUpdate(new Date()) } catch { - + console.log("could not fetch metrics") + return; } } diff --git a/public/favicon.ico b/public/favicon.ico index 9e9b20b..f208b8b 100644 Binary files a/public/favicon.ico and b/public/favicon.ico differ