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.

Sign up for GitHub

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

docs: Update running-the-api.md #193

Merged
merged 4 commits into from
Apr 27, 2024
Merged

docs: Update running-the-api.md #193

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
be6ff3b
Update running-the-api.md
veh3546 Apr 25, 2024
c2963f3
Update running-the-api.md
veh3546 Apr 25, 2024
23afdf0
Update running-the-api.md
veh3546 Apr 25, 2024
73a2403
Update running-the-api.md
veh3546 Apr 26, 2024
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
11 changes: 7 additions & 4 deletions docs/contributing-to-keyshade/running-things-locally/running-the-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,13 +31,16 @@ We currently perform two kinds of tests: **unit tests** and **integration tests.
After you make sure that you have added your unit tests, or you have made some changes to the existing functionality, you can run them using:

```bash
pnpm run test:api
pnpm run unit:api
```

After this is complete, you can run the integration tests. But for that, you would first need your test DB to be up and running. These commands will do of that for you.
After this is complete, you can run end-to-end tests to validate your entire application from start to finish. Use this command:

```bash
docker compose up -d
pnpm run e2e:api
docker compose down
```

You can also skip these first two commands and perform the unit and e2e tests at the same time with:
```bash
pnpm run test:api
```
Loading