docs: updated README.md

This commit is contained in:
Waleed Latif
2025-03-07 00:17:14 -08:00
parent b66ba1ce6c
commit d7337069ce

View File

@@ -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.)