Skip to content

Commit

Permalink
chore: 🔧 merge with main
Browse files Browse the repository at this point in the history
  • Loading branch information
danielbolee committed Feb 29, 2024
2 parents e7881b0 + 3cf6225 commit 32deac1
Show file tree
Hide file tree
Showing 5 changed files with 78 additions and 6 deletions.
7 changes: 1 addition & 6 deletions pages/_meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
}
7 changes: 7 additions & 0 deletions pages/special-projects/_meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"corporate-dashboard": {
"title": "Corporate Dashboard",
"type": "page",
"display": "hidden"
}
}
8 changes: 8 additions & 0 deletions pages/special-projects/corporate-dashboard/_meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"index": {
"title": "Overview"
},
"getting-started": {
"title": "Getting Started"
}
}
61 changes: 61 additions & 0 deletions pages/special-projects/corporate-dashboard/getting-started.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
import { Steps, Callout } from "nextra/components";

# Getting Started

<Callout type="error">
This project is currently private, and only available to ICSSC Projects internal members.
</Callout>

## Setup

<Steps>
### Clone Repository

```bash
git clone https://github.com/icssc/corporate-dashboard.git
cd corporate-dashboard
```

### Install Dependencies

<Callout type="warning">
This project uses pnpm. Use pnpm to install dependencies to avoid mismatching lockfiles.
</Callout>

```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 = <YOUR_ACCESS_KEY_ID>
aws_secret_access_key = <YOUR_SECRET_ACCESS_KEY>
```

</Steps>

## Commands

### Dev

#### With SST

```bash
pnpm dev
```

#### Without SST

```bash
pnpm exec next dev
```

### Build

```bash
pnpm build
```
1 change: 1 addition & 0 deletions pages/special-projects/corporate-dashboard/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Corporate Dashboard

0 comments on commit 32deac1

Please sign in to comment.