Skip to content

Commit

Permalink
chore(internal): Update SETUP.md (#5530)
Browse files Browse the repository at this point in the history
Update SETUP.md
  • Loading branch information
rpc333 authored Jan 6, 2025
1 parent bbebe27 commit a71e81e
Showing 1 changed file with 28 additions and 6 deletions.
34 changes: 28 additions & 6 deletions SETUP.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,29 @@
## Install required packages
# Setup

1. Install [nvm](https://github.com/nvm-sh/nvm#install--update-script)
2. Clone repo
3. `nvm use 18`
4. `npm install --global yarn`
5. `yarn`
The Fern repo is primarily written in TypeScript and relies on [PnPm](https://pnpm.io/) for package management.

Once you have cloned or forked the repository, run through the steps below.

### Step 1: Install dependencies

```sh
pnpm install
```

### Step 2: Compile

To compile all the packages in this monorepo, run `pnpm compile`.

To compile a single package, filter to the relevant package: `pnpm --filter @fern-api/openapi-parser compile`.

### Step 3: Testing

This repo contains both unit tests and integration (end-to-end) tests.

To run all the unit tests: `pnpm test`.

To run unit tests for a single package: `pnpm --filter @fern-api/openapi-parser test`

To run the integration tests: `pnpm test:ete`.

Many of our tests rely on [snapshot testing](https://jestjs.io/docs/snapshot-testing). To rewrite snapshots, use `pnpm test:update` or `pnpm test:ete:update`.

0 comments on commit a71e81e

Please sign in to comment.