Skip to content

Commit

Permalink
Add readme for testing
Browse files Browse the repository at this point in the history
  • Loading branch information
rsca7213 committed Apr 2, 2024
1 parent 2ee1be3 commit 2831e97
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,12 @@ This is a simple example of an Express API written in TypeScript.

- The API will be running on `http://localhost:PORT` where `PORT` is the port number specified in the `.env` file

## 🧪 Running the tests

- Run the tests to check if everything is working as expected

`npm run test`

## 📃 Reading the OpenAPI documentation (Swagger UI)

- To read the OpenAPI documentation, first start the API in development mode
Expand Down

0 comments on commit 2831e97

Please sign in to comment.