Skip to content

Updated "Get Started in 5 Minutes" docs #30

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

Merged
EthanRBrown merged 1 commit into from
Nov 3, 2025
Merged

Updated "Get Started in 5 Minutes" docs #30

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
17 changes: 5 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,7 @@ your operating system and containerization tool.
```
git clone git@github.com:ambarltd/event-sourcing-typescript.git

cd event-sourcing-typescript/local-development/docker-scripts/linux # linux + docker
cd event-sourcing-typescript/local-development/docker-scripts/mac # mac + docker
cd event-sourcing-typescript\local-development\docker-scripts\windows # windows + docker

cd event-sourcing-typescript/local-development/podman-scripts/linux # linux + podman
cd event-sourcing-typescript/local-development/podman-scripts/mac # mac + podman
cd event-sourcing-typescript\local-development\podman-scripts\windows # windows + podman
cd event-sourcing-typescript/development/scripts

# If you're using docker, make sure docker is up and running.
# If you're using podman, make sure podman is up and running. Also make sure there's an active podman machine.
Expand All @@ -34,16 +28,15 @@ echo [automount] >> wsl.conf
echo 'options = "metadata"' >> wsl.conf
```

Then start the application and run the demo.
Then start the application and run the demo (make sure nothing is running on ports 8080, 8081, and 8082;
the React Native dev server is a common culprit).

```
# linux or mac
./dev_start.sh
./dev_demo.sh
./start.sh

# windows
.\dev_start.ps1
.\dev_demo.ps1
.\start.ps1
Comment on lines 35 to +39

@chatgpt-codex-connector chatgpt-codex-connector Bot Nov 3, 2025

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Badge Provide executable Windows startup command

The setup instructions now tell Windows users to run .\start.ps1, but the repository does not contain any PowerShell scripts (git ls-files | grep '.ps1' returns nothing). Following the README will therefore fail on Windows because there is no script to invoke. Either add a PowerShell variant or update the docs to point to an existing script (e.g. via WSL).

Useful? React with 👍 / 👎.

```

You can then open your browser to:
Expand Down