From a03977a5031442ab5fb4b2499c618b129771b0c5 Mon Sep 17 00:00:00 2001 From: Alexander Liu Date: Sat, 24 Feb 2024 15:06:09 -0800 Subject: [PATCH] =?UTF-8?q?fix:=20=F0=9F=90=9B=20replace=20missing=20corpo?= =?UTF-8?q?rate=20dashboard=20docs?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- pages/_meta.json | 7 +-- pages/special-projects/_meta.json | 7 +++ .../corporate-dashboard/_meta.json | 8 +++ .../corporate-dashboard/getting-started.mdx | 61 +++++++++++++++++++ .../corporate-dashboard/index.md | 1 + 5 files changed, 78 insertions(+), 6 deletions(-) create mode 100644 pages/special-projects/_meta.json create mode 100644 pages/special-projects/corporate-dashboard/_meta.json create mode 100644 pages/special-projects/corporate-dashboard/getting-started.mdx create mode 100644 pages/special-projects/corporate-dashboard/index.md diff --git a/pages/_meta.json b/pages/_meta.json index f4ed944..7f4cf53 100644 --- a/pages/_meta.json +++ b/pages/_meta.json @@ -83,13 +83,8 @@ "items": { "corporate-dashboard": { "title": "Corporate Dashboard", - "href": "/corporate-dashboard" + "href": "/special-projects/corporate-dashboard" } } - }, - "corporate-dashboard": { - "title": "Corporate Dashboard", - "type": "page", - "display": "hidden" } } diff --git a/pages/special-projects/_meta.json b/pages/special-projects/_meta.json new file mode 100644 index 0000000..50a22e4 --- /dev/null +++ b/pages/special-projects/_meta.json @@ -0,0 +1,7 @@ +{ + "corporate-dashboard": { + "title": "Corporate Dashboard", + "type": "page", + "display": "hidden" + } +} diff --git a/pages/special-projects/corporate-dashboard/_meta.json b/pages/special-projects/corporate-dashboard/_meta.json new file mode 100644 index 0000000..9742ec7 --- /dev/null +++ b/pages/special-projects/corporate-dashboard/_meta.json @@ -0,0 +1,8 @@ +{ + "index": { + "title": "Overview" + }, + "getting-started": { + "title": "Getting Started" + } +} diff --git a/pages/special-projects/corporate-dashboard/getting-started.mdx b/pages/special-projects/corporate-dashboard/getting-started.mdx new file mode 100644 index 0000000..78aa56e --- /dev/null +++ b/pages/special-projects/corporate-dashboard/getting-started.mdx @@ -0,0 +1,61 @@ +import { Steps, Callout } from "nextra/components"; + +# Getting Started + + + This project is currently private, and only available to ICSSC Projects internal members. + + +## Setup + + +### Clone Repository + +```bash +git clone https://github.com/icssc/corporate-dashboard.git +cd corporate-dashboard +``` + +### Install Dependencies + + + This project uses pnpm. Use pnpm to install dependencies to avoid mismatching lockfiles. + + +```bash +pnpm install +``` + +### Setup IAM Credentials _Optional_ + +This is an optional step only available for ICSSC Projects internal members. If this is your first time setting up an ICSSC project using SST, request credentials from your project lead. If you've already set up IAM Credentials for another ICSSC project, this step is not necessary. + +``` +[default] +aws_access_key_id = +aws_secret_access_key = +``` + + + +## Commands + +### Dev + +#### With SST + +```bash +pnpm dev +``` + +#### Without SST + +```bash +pnpm exec next dev +``` + +### Build + +```bash +pnpm build +``` diff --git a/pages/special-projects/corporate-dashboard/index.md b/pages/special-projects/corporate-dashboard/index.md new file mode 100644 index 0000000..a39b9aa --- /dev/null +++ b/pages/special-projects/corporate-dashboard/index.md @@ -0,0 +1 @@ +# Corporate Dashboard