-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
78 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
{ | ||
"corporate-dashboard": { | ||
"title": "Corporate Dashboard", | ||
"type": "page", | ||
"display": "hidden" | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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
61
pages/special-projects/corporate-dashboard/getting-started.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
# Corporate Dashboard |