summaryrefslogtreecommitdiff
path: root/docs/dev/getting-started.md
diff options
context:
space:
mode:
authorDavid Mehren2020-07-10 19:59:32 +0200
committerGitHub2020-07-10 19:59:32 +0200
commit3db8b0df43b027d15d13047e25617266ddc57f13 (patch)
treeda64f90f7cd4ab4c1deaf67a572a45c2a583dc7e /docs/dev/getting-started.md
parent0b7dbd1f43899b4321ddf41bf98a64a7bd5fa48d (diff)
parent89895cef2e5785134bf1fdcc9c8813831c07f17b (diff)
Merge pull request #410 from oupala/feature/markdown-linting
Diffstat (limited to '')
-rw-r--r--docs/dev/getting-started.md17
1 files changed, 8 insertions, 9 deletions
diff --git a/docs/dev/getting-started.md b/docs/dev/getting-started.md
index 9a35b71a..7ed96944 100644
--- a/docs/dev/getting-started.md
+++ b/docs/dev/getting-started.md
@@ -1,5 +1,4 @@
-Developer Notes
-===
+# Developer Notes
## Preparing for running the code
@@ -7,20 +6,20 @@ Developer Notes
1. Clone the repository with `git clone https://github.com/codimd/server.git codimd-server`
(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. `yarn run build` will build the frontend bundle. It uses webpack to do that.
-5. Run the server with `node app.js`
-
+1. `yarn run build` will build the frontend bundle. It uses webpack to do that.
+2. Run the server with `node app.js`
## Running the Code with Auto-Reload
@@ -32,11 +31,11 @@ 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 `yarn run dev` if you want webpack to continuously rebuild the frontend
+1. Use `yarn 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`.
+2. 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