Skip to content

Commit

Permalink
docs: add minimal docs on how to develop
Browse files Browse the repository at this point in the history
  • Loading branch information
tefkah committed May 22, 2024
1 parent 3a6aa44 commit 7fb7481
Showing 1 changed file with 46 additions and 0 deletions.
46 changes: 46 additions & 0 deletions development.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Development

These are internal notes for the development of the project.

## Installation

Install dependencies

```bash
pnpm i
```

Setup environment correctly

```bash
cp .env.example .env
```

Look in the usual place for the relevant variables.

## Running tests

Before running tests, make sure you load the environment variables from the `.env` file.

```bash
source .env
```

> [!NOTE]
> This is only necessary because I cannot for the life of me find out how to load the environment variables from the `.env` file in the `jest.config.ts` file.
Then, to run the tests, run

```bash
pnpm test
```

## Publishing

Just run

```bash
pnpm publish
```

This will create a new release in the `changeset` package.

0 comments on commit 7fb7481

Please sign in to comment.