From 74fdd26ea057dab77e761614497d69d2c90a66d7 Mon Sep 17 00:00:00 2001
From: Claudius
Date: Sun, 31 Mar 2019 18:57:26 +0200
Subject: integrating information from the old wiki

Signed-off-by: Claudius <opensource@amenthes.de>
---
 docs/dev/getting-started.md | 49 +++++++++++++++++++++++++++++++++++++++++----
 1 file changed, 45 insertions(+), 4 deletions(-)

(limited to 'docs/dev/getting-started.md')

diff --git a/docs/dev/getting-started.md b/docs/dev/getting-started.md
index 6eb1b136..79a97d4a 100644
--- a/docs/dev/getting-started.md
+++ b/docs/dev/getting-started.md
@@ -1,13 +1,54 @@
 # Developer Notes
 
+## Preparing for running the code
+
+**Notice:** *If you're into [docker](../setup/docker.md) or [heroku](../setup/heroku.md),
+there's extra documents for those!*
+
+1. Clone the repository (Cloning is the preferred way, but you can also download
+   and unzip a release)
+2. Enter the directory and run `bin/setup`, which will install npm dependencies
+   and create configs. The setup script is written in Bash, you would need bash
+   as a prerequisite.
+3. Setup the [config file](../configuration-config-file.md) or set up
+   [environment variables](../configuration-env-vars.md).
+
+
+## Running the Code
+
+Now that everything is in place, we can start CodiMD:
+
+4. `npm run build` will build the frontend bundle. It uses webpack to do that.
+5. Run the server with `node app.js`
+
+
+## Running the Code with Auto-Reload
+
+The commands above are fine for production, but you're a developer and surely
+you want to change things. You would need to restart both commands whenever you
+change something. Luckily, you can run these commands that will automatically
+rebuild the frontend or restart the server if necessary.
+
+The commands will stay active in your terminal, so you will need multiple tabs
+to run both at the same time.
+
+4. Use `npm run dev` if you want webpack to continuously rebuild the frontend
+   code.
+5. To auto-reload the server, the easiest method is to install [nodemon](https://www.npmjs.com/package/nodemon)
+   and run `nodemon --watch app.js --watch lib --watch locales app.js`.
+
+
 ## Structure
 
+The repository contains two parts: a server (backend) and a client (frontend).
+most of the server code is in `/lib` and most of the client code is in `public`.
+
 ```text
-codimd/
-├── test/           --- test suite
+codimd-server/
 ├── docs/           --- documentation
-├── lib/            --- server libraries
-└── public/         --- client files
+├── lib/            --- server code
+├── test/           --- test suite
+└── public/         --- client code
     ├── css/        --- css styles
     ├── docs/       --- default documents
     ├── js/         --- js scripts
-- 
cgit v1.2.3