chore: readme

.env.example

@@ -0,0 +1,2 @@
+DATABASE_URL="mysql://root:password@127.0.0.1:3306/earthworm_nest"
+SECRET="sjldk92#sd903mnc./xklsjdf9sdfj"

README.md

@@ -0,0 +1,31 @@
+# Earthworm
+
+## How to run
+
+### in mac
+
+1. Install dependencies
+```bash
+brew install docker orbstack
+```
+2. open orbstack
+
+3. run commands
+```bash
+## In this project directory
+## Run sql and redis services
+docker compose up -d
+## Configure environment variables 
+cp .env.example .env
+pnpm install
+pnpm db:init
+pnpm data:init
+```
+4. run serve
+```bash
+pnpm serve:dev
+```
+5. run client
+```run
+pnpm client:dev
+```

docker-compose.yml

@@ -0,0 +1,21 @@
+version: '3.8'
+
+services:
+  mysql:
+    image: mysql:latest
+    environment:
+      MYSQL_ROOT_PASSWORD: password
+      MYSQL_DATABASE: earthworm_nest
+    command: --default-authentication-plugin=mysql_native_password
+    ports:
+      - "3306:3306"
+  redis:
+    image: redis:5-alpine
+    restart: always
+    volumes:
+      - redis_data:/var/lib/redis
+    ports:
+      - 6379:6379
+volumes:
+  redis_data:
+    driver: local