From d8b03d387ad920305f3b2f7bc7a4eb44735ed7b6 Mon Sep 17 00:00:00 2001
From: Nikita Melnikov <nikmel2803@gmail.com>
Date: Sun, 2 Oct 2022 17:23:45 +0800
Subject: [PATCH] update development docs

---
 .gitignore      |  2 ++
 DEVELOPMENT.md  | 28 ++++++++++++++++++++++++++++
 README.md       |  4 ++++
 app-config.yaml |  2 +-
 package.json    |  2 +-
 5 files changed, 36 insertions(+), 2 deletions(-)
 create mode 100644 DEVELOPMENT.md

diff --git a/.gitignore b/.gitignore
index 693fcab..0f84a0a 100644
--- a/.gitignore
+++ b/.gitignore
@@ -81,3 +81,5 @@ db/
 # Compiled files
 /dist/*
 /public/dist/*
+
+*.local.yaml
diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md
new file mode 100644
index 0000000..3db8fa3
--- /dev/null
+++ b/DEVELOPMENT.md
@@ -0,0 +1,28 @@
+# Development guide
+
+This doc describes how to bootstrap and run the project locally.
+
+## Setup
+
+### 1. Clone the repo.
+```shell
+git clone https://github.com/codex-team/codex.docs
+```
+
+### 2. Install dependencies
+
+```shell
+yarn install
+```
+
+### 3. Create separate config file for local overrides
+
+```shell
+touch app-config.local.yaml
+```
+
+### 4. Run the application
+
+```shell
+yarn dev
+```
diff --git a/README.md b/README.md
index 0e0b490..c233a9d 100644
--- a/README.md
+++ b/README.md
@@ -66,6 +66,10 @@ docker-compose up
 
 We have the ready-to-use [Helm chart](https://github.com/codex-team/codex.docs.chart) to deploy project in Kubernetes
 
+## Development
+
+See documentation for developers in [DEVELOPMENT.md](./DEVELOPMENT.md).
+
 # About CodeX
 
 <img align="right" width="120" height="120" src="https://codex.so/public/app/img/codex-logo.svg" hspace="50">
diff --git a/app-config.yaml b/app-config.yaml
index fb4282f..d98d2a1 100644
--- a/app-config.yaml
+++ b/app-config.yaml
@@ -24,7 +24,7 @@ hawk:
 #  backendToken: "123"
 
 database:
-  driver: mongodb
+  driver: local # you can change database driver here. 'mongodb' or 'local'
   local:
     path: ./db
   mongodb:
diff --git a/package.json b/package.json
index 8c87c02..0376ce9 100644
--- a/package.json
+++ b/package.json
@@ -9,7 +9,7 @@
   "scripts": {
     "start": "concurrently \"yarn start-backend\" \"yarn build-frontend\"",
     "dev": "concurrently \"yarn start-backend\" \"yarn build-frontend:dev\"",
-    "start-backend": "cross-env NODE_ENV=development npx nodemon --config nodemon.json ./src/bin/server.ts",
+    "start-backend": "cross-env NODE_ENV=development npx nodemon --config nodemon.json ./src/bin/server.ts -c app-config.yaml -c app-config.local.yaml",
     "compile": "tsc && copyfiles -u 3 ./src/**/*.twig ./dist/backend/views && copyfiles -u 1 ./src/**/*.svg ./dist/",
     "build-frontend": "webpack --mode=production",
     "build-frontend:dev": "webpack --mode=development --watch",