overleaf icon indicating copy to clipboard operation
overleaf copied to clipboard

Explain the steps to run it locally

Open RetiefLouw opened this issue 3 months ago • 0 comments

Thanks! This guide was very helpful. Overleaf has their own guide but they complicate it with too many additional notes that are irrelevant and only applicable to advanced deployments. Your strength is that you have simplified it.

You can simplify this further. It is difficult to know what the steps are in your current version.

Here is a suggested change.

Prerequisites Ensure Docker and Docker Compose are installed and running. The setup requires building a TeX Live image for PDF compilation.

Steps

  1. Navigate to the development directory: cd develop
  2. Build the TeX Live image (required for compiling PDFs): docker build texlive -t texlive-full
  3. Build the services: bin/build
  4. Start the services: bin/up
  5. Access the application: Once running, open [http://localhost/launchpad] in your browser to create the first admin account. The main application should be available at [http://localhost].

Development Mode (Optional) For faster iteration during development (services auto-restart on code changes):

Run bin/dev instead of bin/up. You can specify specific services: bin/dev [service1] [service2]. Note: For frontend changes, also include the webpack service.

Additional Notes Note: If Docker runs out of RAM during parallel builds, create a .env file in the develop/ directory with COMPOSE_PARALLEL_LIMIT=1 and retry. If the port is already being used, change port 80 to any other port like 8087. Services run in Docker containers, so no local Node.js installation is needed. If you encounter permission issues with Docker socket, the setup handles it automatically. For debugging, services expose ports (e.g., web on 9229) for attaching debuggers like Chrome DevTools. Refer to README.md for more details on configuration and troubleshooting.

RetiefLouw avatar Sep 05 '25 09:09 RetiefLouw