From d7337069cef23ab71c5b81bc86bc6e4d254a9338 Mon Sep 17 00:00:00 2001 From: Waleed Latif Date: Fri, 7 Mar 2025 00:17:14 -0800 Subject: [PATCH] docs: updated README.md --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/README.md b/README.md index 4064068b34..31bdf94a4c 100644 --- a/README.md +++ b/README.md @@ -24,12 +24,38 @@ There are several ways to self-host Sim Studio: git clone https://github.com/YOUR_USERNAME/sim.git cd sim +# Create environment file +cp .env.example .env + # Start the Docker environment docker compose up -d # Or use the helper script ./scripts/start_simstudio_docker.sh ``` +After running these commands: + +1. **Access the Application**: + + - Open [http://localhost:3000/w/](http://localhost:3000/w/) in your browser + - The `/w/` path is where the main workspace interface is located + +2. **Useful Docker Commands**: + + ```bash + # View application logs + docker compose logs -f simstudio + + # Access PostgreSQL database + docker compose exec db psql -U postgres -d simstudio + + # Stop the environment + docker compose down + + # Rebuild and restart (after code changes) + docker compose up -d --build + ``` + ### Option 2: Dev Containers 1. Open VS Code or your favorite VS Code fork (Cursor, Windsurf, etc.)