Skip to content

Commit

Permalink
docs: add instructions for running tests (#2587)
Browse files Browse the repository at this point in the history
<!--
☝️ PR title should follow conventional commits
(https://conventionalcommits.org).
In particular, the title should start with one of the following types:

- docs: 📖 Documentation (updates to the documentation or readme)
- fix: 🐞 Bug fix (a non-breaking change that fixes an issue)
- feat: ✨ New feature/enhancement (a non-breaking change that adds
functionality or improves existing one)
- feat!/fix!: ⚠️ Breaking change (fix or feature that would cause
existing functionality to change)
- chore: 🧹 Chore (updates to the build process or auxiliary tools and
libraries)
-->

### 🔗 Linked issue

<!-- If it resolves an open issue, please link the issue here. For
example "Resolves #123" -->

### 📚 Description

<!-- Describe your changes in detail -->
<!-- Why is this change required? What problem does it solve? -->
  • Loading branch information
tobiasdiez authored Dec 26, 2024
1 parent decb9e4 commit 6c07755
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,20 @@ Now close and re-open the workspace.
| pnpm prisma:studio | Explore data in the database using a visual editor. |
| pnpm storybook | Start [Storybook](#ui-workflow-storybook) in your browser. |

### Running tests locally

To run the tests locally, it's best to start the development server by running `pnpm dev`.
Then, in a separate terminal, set the environment variable `TEST_URL` to the URL of the development server (e.g., `http://localhost:3000`)

```bash
# Linux
export TEST_URL=http://localhost:3000
# Windows
$env:TEST_URL = "http://localhost:3000"
```

Then you can run the tests by executing `pnpm test`.

### Workflow for editing the database schema

1. Prototype your new feature by making the necessary changes to `schema.prisma`.
Expand Down

0 comments on commit 6c07755

Please sign in to comment.