diff options
author | David Mehren | 2020-11-15 21:02:36 +0100 |
---|---|---|
committer | GitHub | 2020-11-15 21:02:36 +0100 |
commit | 4c0efe1237bc33b52d06eaf86a28adad9a041ec2 (patch) | |
tree | fa068d16074645b7b6d8d88b78724b9cd82dd879 /docs/dev/getting-started.md | |
parent | 299301f0fe5bea41b4407bbbc03932fc4dd1c1d3 (diff) | |
parent | 9898ab3ca5fa226967d8a3aca8e6e752554ed64d (diff) |
Merge pull request #453 from hedgedoc/misc/renaming
Diffstat (limited to 'docs/dev/getting-started.md')
-rw-r--r-- | docs/dev/getting-started.md | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/dev/getting-started.md b/docs/dev/getting-started.md index 7ed96944..b0623926 100644 --- a/docs/dev/getting-started.md +++ b/docs/dev/getting-started.md @@ -4,7 +4,7 @@ **Notice:** *There's [specialised instructions for docker](../setup/docker.md) or [heroku](../setup/heroku.md), if you prefer running code this way!* -1. Clone the repository with `git clone https://github.com/codimd/server.git codimd-server` +1. Clone the repository with `git clone https://github.com/hedgedoc/hedgedoc.git hedgedoc-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 @@ -16,7 +16,7 @@ ## Running the Code -Now that everything is in place, we can start CodiMD: +Now that everything is in place, we can start HedgeDoc: 1. `yarn run build` will build the frontend bundle. It uses webpack to do that. 2. Run the server with `node app.js` @@ -43,7 +43,7 @@ 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-server/ +hedgedoc-server/ ├── docs/ --- documentation ├── lib/ --- server code ├── test/ --- test suite |