Update README.md

.env.sample

@@ -0,0 +1,23 @@
+PGHOST=localhost
+PGPORT=5432
+PGDATABASE=paradb
+PGUSER=paradb
+PGPASSWORD=1234
+SENTRY_DSN=sentryDsn
+SENTRY_ENV=sentryEnv
+COOKIE_NAME=pdb:session
+COOKIE_SECRET=Henchman-Enamel-Amusable-Blatancy-Circus
+PUBLIC_S3_BASE_URL=https://test.example.com
+S3_ENDPOINT=http://localhost:9000
+S3_REGION=local
+S3_ACCESS_KEY_ID=abc
+S3_ACCESS_KEY_SECRET=12345678
+S3_MAPS_BUCKET=paradb-maps-test
+MEILISEARCH_HOST=localhost:7700
+MEILISEARCH_KEY=123
+MAPS_DIR=/tmp/
+FRONTEND_ASSETS=/tmp/
+STATIC_ASSETS=/tmp/
+PARADB_MAPS_DIR=/tmp/maps
+MEILISEARCH_DATA_DIR=/tmp/meilisearch_data
+POSTGRES_DATA_DIR=/tmp/postgres_data

README.md

@@ -1,24 +1,38 @@
-## Installation
+## Requirements
+
+- [Docker](https://www.docker.com/) and Docker Compose
+- [Node.js](https://nodejs.org/) (version 18 or higher)
+- [Yarn](https://yarnpkg.com/) package manager
 
-```
-# Clone and install deps
-git clone https://github.com/bitnimble/paradb.git
-cd paradb
-yarn
+## Installation
 
-# Install and start postgres
-sudo apt install postgresql
-sudo service postgresql start
+1. **Clone the repository**
+   ```bash
+   git clone https://github.com/bitnimble/paradb.git
+   cd paradb
+   ```
 
-# Create postgres user for yourself
-sudo -u postgres createuser --interactive --pwprompt
+2. **Create environment file**
+   ```bash
+   cp .env.sample .env
+   ```
+   Then edit the `.env` file with your specific configuration values.
 
-# Edit .env to fill out your username and password!
+3. **Install dependencies**
+   ```bash
+   yarn
+   ```
 
-# Create db and instantiate schema
-createdb paradb
-db/init.sh
+4. **Start the development environment**
+   ```bash
+   yarn dev
+   ```
+
+   Alternatively, you can use Docker Compose directly:
+   ```bash
+   docker compose -f docker/docker-compose.dev.yml --env-file .env up
+   # or in detached mode
+   docker compose -f docker/docker-compose.dev.yml --env-file .env up -d
+   ```
 
-# Start server
-yarn dev
-```
+The application will be available at http://localhost:3000 once all services are running.