Update readme.md #4001
Update readme.md #4001
Conversation
removed frontend documentation for more clarity
| @@ -31,8 +28,6 @@ Open a command line or terminal, and navigate to the `app` folder (where this `r | |||
|
|
|||
| Install `docker` from <https://docs.docker.com/engine/install/>. | |||
|
|
|||
| Install `docker-compose` from <https://docs.docker.com/compose/install/>. | |||
There was a problem hiding this comment.
merged in docker since July 2023
| @@ -51,7 +46,7 @@ An alternative on **macOS** is to install the tools locally with `brew install g | |||
| If you are on **Windows** (without WSL2), run the following command: | |||
|
|
|||
| ```sh | |||
| docker run --pull always --rm -w /app -v %cd%:/app registry.gitlab.com/couchers/grpc sh -c "cat generate_protos.sh | dos2unix | sh" | |||
| docker run --pull always --rm -w /app -v ${PWD}/app:/app registry.gitlab.com/couchers/grpc sh -c "apt-get update && apt-get install dos2unix && cat generate_protos.sh | dos2unix | sh" | |||
There was a problem hiding this comment.
solved command on windows
There was a problem hiding this comment.
If dos2unix is not in the container, then I think we should add it there instead of installing it here
There was a problem hiding this comment.
sure, thing is, I don't have access to it 🙃
There was a problem hiding this comment.
It's here: https://github.com/Couchers-org/grpc
There was a problem hiding this comment.
I've installed it there now, so no need to install here!
| @@ -11,9 +11,6 @@ To **run the app locally**, you need to do **four things**: | |||
| 1. Get the code, navigate to the `app` folder and install `docker` and `docker-compose` | |||
| 2. Compile the protocol buffers | |||
| 3. Launch the backend with `docker-compose` | |||
| 4. Install and launch the web frontend with `yarn` | |||
There was a problem hiding this comment.
I would keep this step, but instead include a link to the front-end repo, e.g.:
Install and launch the web frontend
| @@ -11,9 +11,6 @@ To **run the app locally**, you need to do **four things**: | |||
| 1. Get the code, navigate to the `app` folder and install `docker` and `docker-compose` | |||
| 2. Compile the protocol buffers | |||
| 3. Launch the backend with `docker-compose` | |||
| 4. Install and launch the web frontend with `yarn` | |||
|
|
|||
| Are you only developing on the web frontend? If you don't want to install docker, you can follow the alterative instructions in `web/readme.md`. | |||
There was a problem hiding this comment.
I would keep this, but update it to say something like:
Are you only developing on the web frontend? You can run the frontend by itself, just follow instructions outlined in "add link here"
| @@ -11,9 +11,6 @@ To **run the app locally**, you need to do **four things**: | |||
| 1. Get the code, navigate to the `app` folder and install `docker` and `docker-compose` | |||
There was a problem hiding this comment.
Let's update here as well to instruct them to only install docker
documentation change, in order to improve clarity (for the dev experience)