github/hedgedoc
1
0
Fork 0
mirror of https://github.com/hedgedoc/hedgedoc.git synced 2024-11-28 12:11:00 -05:00
Code Issues Projects Releases Packages Wiki Activity

docs: fix some typos

Browse source 
Signed-off-by: Philip Molares <philip.molares@udo.edu>
This commit is contained in:
Philip Molares 2022-07-31 21:18:34 +02:00 committed by Yannick Bungers
parent d152402709
commit eb11545ca7
1 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
docs/content/dev/getting-started.md
View file

@ -2,7 +2,7 @@
## Preparing for running the backend code ## Preparing for running the backend code
**ToDo:** Document how to setup development environment using docker. **ToDo:** Document how to set up development environment using docker.
1. Clone the repository with `git clone https://github.com/hedgedoc/hedgedoc.git` 1. Clone the repository with `git clone https://github.com/hedgedoc/hedgedoc.git`
(cloning is the preferred way, but you can also download and unzip a release) (cloning is the preferred way, but you can also download and unzip a release)
@ -18,16 +18,16 @@
## Preparing for running the frontend code ## Preparing for running the frontend code
**ToDo:** Document how to setup development environment using docker. **ToDo:** Document how to set up development environment using docker.
1. Clone the repository with `git clone https://github.com/hedgedoc/react-client.git` 1. Clone the repository with `git clone https://github.com/hedgedoc/react-client.git`
(cloning is the preferred way, but you can also download and unzip a release) (cloning is the preferred way, but you can also download and unzip a release)
2. Enter the directory and run `yarn install`. 2. Enter the directory and run `yarn install`.
## Running Hedgedoc with auto-reload ## Running HedgeDoc with auto-reload
We will run Hedgedoc in development mode, which means the backend and frontend will automatically rebuild or restart when you make changes. We will run HedgeDoc in development mode, which means the backend and frontend will automatically rebuild or restart when you make changes.
The commands will stay active in your terminal, so you will need multiple tabs The commands will stay active in your terminal, so you will need multiple tabs
to run both at the same time. to run both at the same time.
@ -40,8 +40,8 @@ to run both at the same time.
## Testing ## Testing
- After starting both frontend and backend, Hedgedoc will be available at `http://localhost:3000`. - After starting both frontend and backend, HedgeDoc will be available at `http://localhost:3000`.
**Note:** If you only started the frontend, it will be available at `http://localhost:3001`. **Note:** If you only started the frontend, it will be available at `http://localhost:3001`.
**Note:** If you want to use Hedgedoc with the real backend, point your browser at `http://localhost:3000`, as the backend proxies requests to the frontend and you'll get CORS errors if you try to use the frontend directly. **Note:** If you want to use HedgeDoc with the real backend, point your browser at `http://localhost:3000`, as the backend proxies requests to the frontend and you'll get CORS errors if you try to use the frontend directly.