Merge pull request #9725 from overleaf/ae-overleaf-develop-ce

Add Server CE development environment

GitOrigin-RevId: c91d9eb58b1dbc3be24646e77033cd3242e707f0

develop/README.md

@@ -0,0 +1,79 @@
+# Overleaf Community Edition, development environment
+
+## Building and running
+
+In this `develop` directory, build and start the services:
+
+```shell
+bin/up
+```
+
+Once the services are running, open <http://localhost/launchpad> to create the first admin account.
+
+After making any changes to the code, run `bin/up` manually to rebuild the changed Docker images and recreate the changed containers.
+
+## TeX Live
+
+Compiling a PDF requires building a TeX Live image to handle the compilation inside Docker:
+
+```shell
+docker build texlive -t texlive-full
+```
+
+> **Note**
+> To compile on a macOS host, you'll need to override the path to the Docker socket by creating a `.env` file in this directory, containing
+> `DOCKER_SOCKET_PATH=/var/run/docker.sock.raw`
+
+## Development
+
+To avoid running `bin/up` after every code change, you can run Overleaf
+Community Edition in _development mode_, where services will automatically
+update on code changes. To do this, use the included `bin/dev` script:
+
+```shell
+bin/dev
+```
+
+This will start all services using `nodemon`, which will automatically monitor
+the code and restart the services as necessary. This will incur a performance
+hit, especially on macOS, so in order to only start a subset of the services,
+provide a space-separated list to the `bin/dev` script.
+
+```shell
+bin/dev [service1] [service2] ...  [serviceN]
+```
+
+> **Note**
+> Starting the `web` service in _development mode_ will only update the `web`
+> service when backend code changes. In order to automatically update frontend
+> code as well, make sure to start the `webpack` service in _development mode_
+> as well.
+
+## Debugging
+
+When run in _development mode_ most services expose a debugging port to which
+you can attach a debugger such as
+[the inspector in Chrome's Dev Tools](chrome://inspect/) or one integrated into
+an IDE. The following table shows the port exposed on the **host machine** for
+each service:
+
+| Service            | Port |
+| ------------------ | ---- |
+| `web`              | 9229 |
+| `clsi`             | 9230 |
+| `chat`             | 9231 |
+| `contacts`         | 9232 |
+| `docstore`         | 9233 |
+| `document-updater` | 9234 |
+| `filestore`        | 9235 |
+| `notifications`    | 9236 |
+| `real-time`        | 9237 |
+| `track-changes`    | 9238 |
+
+To attach to a service using Chrome's _remote debugging_, go to
+<chrome://inspect/> and make sure _Discover network targets_ is checked. Next
+click _Configure..._ and add an entry `localhost:[service port]` for each of the
+services you want to attach a debugger to.
+
+After adding an entry, the service will show up as a _Remote Target_ that you
+can inspect and debug.