Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Zotistics Getting Started #10

Merged
merged 1 commit into from
Apr 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion pages/zotistics/getting-started.md

This file was deleted.

69 changes: 69 additions & 0 deletions pages/zotistics/getting-started.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
import { Steps, Callout } from "nextra/components";

# Getting Started

## Setup

<Steps>
### Clone Repository

```bash
git clone https://github.com/icssc/Zotistics.git
cd Zotistics
```

### 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
```

### Lint and Fix

```bash
pnpm lint
```

### Format

```bash
pnpm format
```
Loading