Skip to content

Commit

Permalink
Merge pull request #2 from aulasoftwarelibre/update-readme
Browse files Browse the repository at this point in the history
chore: update README
  • Loading branch information
sgomez authored Aug 11, 2024
2 parents cb8e58c + 8f488ad commit d46795c
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 13 deletions.
11 changes: 0 additions & 11 deletions Dockerfile

This file was deleted.

21 changes: 19 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,10 @@ You require to have a nestjs project with this modules already installed and loa

npm install @aulasoftwarelibre/nestjs-eventstore

- pnpm

npm add @aulasoftwarelibre/nestjs-eventstore

- yarn

yarn add @aulasoftwarelibre/nestjs-eventstore
Expand All @@ -63,13 +67,26 @@ Distributed under the EUPL-1.2 License. See `LICENSE` for more information.

## Running the example

To run the example you will need docker. Just run:
To run the example you will build the library first:

```shell
pnpm run build
```

Then go to the example folder an run the containers:

```shell
cd examples/banking
docker compose up -d
```

And a few minutes later you will access to the example application in the next urls:
And finally run the project:

```shell
pnpm run start:dev
```

You will access to the example application in the next urls:

- [Swagger API](http://localhost:3000/api/)
- [EventStore Database (Write model)](http://localhost:2113)
Expand Down

0 comments on commit d46795c

Please sign in to comment.