From 72ed0abe1e109066f7c5003d411fcca4be3f3534 Mon Sep 17 00:00:00 2001 From: Alexander Liu Date: Sat, 24 Feb 2024 15:13:19 -0800 Subject: [PATCH] =?UTF-8?q?docs:=20=F0=9F=93=9A=EF=B8=8F=20zotistics=20get?= =?UTF-8?q?ting=20started?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- pages/zotistics/getting-started.md | 1 - pages/zotistics/getting-started.mdx | 69 +++++++++++++++++++++++++++++ 2 files changed, 69 insertions(+), 1 deletion(-) delete mode 100644 pages/zotistics/getting-started.md create mode 100644 pages/zotistics/getting-started.mdx diff --git a/pages/zotistics/getting-started.md b/pages/zotistics/getting-started.md deleted file mode 100644 index bad5562..0000000 --- a/pages/zotistics/getting-started.md +++ /dev/null @@ -1 +0,0 @@ -# Getting Started diff --git a/pages/zotistics/getting-started.mdx b/pages/zotistics/getting-started.mdx new file mode 100644 index 0000000..284baf5 --- /dev/null +++ b/pages/zotistics/getting-started.mdx @@ -0,0 +1,69 @@ +import { Steps, Callout } from "nextra/components"; + +# Getting Started + +## Setup + + +### Clone Repository + +```bash +git clone https://github.com/icssc/Zotistics.git +cd Zotistics +``` + +### 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 +``` + +### Lint and Fix + +```bash +pnpm lint +``` + +### Format + +```bash +pnpm format +```