Running the Platform Locally

Installation and usage guide

1. Install Tmux: Ensure tmux is installed on your system.

2. Configure Paths: Modify the script to correctly point to the apify-core and apify-dev-stack directories. These configuration options are located at the beginning of the script file.

3. Initiate Session: From the directory where the script is located, execute the following command:

   npm run platform

   This command will launch a tmux session. The cursor will automatically be moved from the primary pane (gray) to the secondary (Docker) pane.

4. Start Docker: Within the Docker pane, enter your SSH token password to initiate the Docker services.

5. Continue Setup: Once the development stack has successfully started, navigate back to the primary pane and execute:

   npm run continue

   This will begin the startup process for the API, frontend, and daemon services, each displayed in its dedicated tmux pane.

6. Terminate Session: To exit the entire tmux session and stop all running services, use the command:

   npm run kill

Layout

+---------------------------------+
|                0                |
|            Main Pane            |
+----------------+----------------+
|       1        |        2       |
|     Docker     |       API      |
+----------------+----------------+
|       2        |        4       |
|    Frontend    |     Daemons    |
+----------------+----------------+