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

chore: update README #2

Merged
merged 1 commit into from
Aug 11, 2024
Merged

chore: update README #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 0 additions & 11 deletions Dockerfile
View file
Open in desktop

This file was deleted.

21 changes: 19 additions & 2 deletions README.md
View file
Open in desktop
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
Loading