feat: docker setup for local development (#29)

* feat: docker for development

* docs: docker documentation

* fix: update credentials for db

Author: Bashamega

.env.example

@@ -4,5 +4,5 @@
 # Prisma supports the native connection string format for PostgreSQL, MySQL, SQLite, SQL Server, MongoDB and CockroachDB.
 # See the documentation for all the connection string options: https://pris.ly/d/connection-strings
 
-DATABASE_URL="postgresql://localhost:5432/trending?schema=public"
+DATABASE_URL="postgresql://postgres:postgres@localhost:5432/trending?schema=public"
 API_TOOL_KIT_TOKEN=""

README.md

@@ -164,7 +164,14 @@ GET `/daily?date=2024-09-13`
 ## Requirements
 
 - nodejs
-- postgres
+- postgres (can be run in Docker)
+
+## Running Postgres in Docker (optional)
+To run postgres in docker, run the following command:
+
+```bash
+npm run docker
+```
 
 ## Project setup
 

docker-compose.yml

@@ -0,0 +1,11 @@
+version: "3"
+services:
+  db:
+    image: postgres:latest # You can specify a version, e.g., postgres:13
+    restart: always
+    ports:
+      - "5432:5432"
+    environment:
+      POSTGRES_USER: postgres
+      POSTGRES_PASSWORD: postgres
+      POSTGRES_DB: db

package.json

@@ -19,7 +19,8 @@
     "test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand",
     "test:e2e": "jest --config ./test/jest-e2e.json",
     "db:migrate:dev": "prisma migrate dev",
-    "db:migrate:prod": "prisma migrate deploy"
+    "db:migrate:prod": "prisma migrate deploy",
+    "docker": "docker compose up -d"
   },
   "dependencies": {
     "@nestjs/common": "^10.0.0",