Skip to content

Commit b538e5d

Browse files
committed
updated README.md
1 parent 1606f19 commit b538e5d

File tree

1 file changed

+11
-22
lines changed

1 file changed

+11
-22
lines changed

README.md

Lines changed: 11 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -22,24 +22,21 @@ The easiest way to get started:
2222

2323
```bash
2424
npx simstudio
25+
# This will set up and run Sim Studio locally with minimal configuration
2526
```
2627

27-
28-
### Option 2: Using Docker Compose Directly
28+
### Option 2: Using Docker Compose
2929

3030
```bash
3131
# Clone the repository
3232
git clone https://github.com/simstudioai/sim.git
3333
cd sim
3434

35-
# Create environment file
35+
# Create environment file (update BETTER_AUTH_SECRET and ENCRYPTION_KEY with secure random values)
3636
cp sim/.env.example sim/.env
3737

3838
# Start with Docker Compose
3939
docker compose up -d --build
40-
41-
# Or use the provided script
42-
./start_simstudio_docker.sh
4340
```
4441

4542
Once running, access the application at [http://localhost:3000/w/](http://localhost:3000/w/)
@@ -96,19 +93,16 @@ services:
9693
9794
### Required Environment Variables
9895
99-
For local development, the minimal required variables are:
96+
For local development, create a `.env` file with these minimum variables:
10097

10198
```env
10299
DATABASE_URL=postgresql://postgres:postgres@db:5432/simstudio
103-
POSTGRES_URL=postgresql://postgres:postgres@db:5432/simstudio
104-
BETTER_AUTH_SECRET=your_auth_secret_here
105-
ENCRYPTION_KEY=your_encryption_key_here
100+
BETTER_AUTH_SECRET=<generate_a_secure_random_value>
101+
ENCRYPTION_KEY=<generate_a_secure_random_value>
106102
```
107103

108104
⚠️ **Note:** Without `RESEND_API_KEY`, verification codes will be logged to the console for local testing.
109105

110-
See `.env.example` for all available configuration options.
111-
112106
### Dev Container Option
113107
1. Open in VS Code with the Remote-Containers extension
114108
2. Click "Reopen in Container" when prompted
@@ -123,18 +117,13 @@ npx drizzle-kit push
123117
npm run dev
124118
```
125119

126-
## Useful Docker Commands
120+
## Troubleshooting
127121

128-
```bash
129-
# View application logs
130-
docker compose logs -f simstudio
131-
132-
# Access PostgreSQL database
133-
docker compose exec db psql -U postgres -d simstudio
122+
Common issues and solutions:
134123

135-
# Stop the environment
136-
docker compose down
137-
```
124+
- **Authentication problems**: Check console logs for verification codes if `RESEND_API_KEY` is not set
125+
- **Database connection errors**: Verify PostgreSQL is running and credentials are correct
126+
- **Port conflicts**: Check if port 3000 is already in use by another application
138127

139128
## Tech Stack
140129

0 commit comments

Comments
 (0)