From e5e46e8e6270ff47387efb4699940d6661e3217e Mon Sep 17 00:00:00 2001 From: Karishma Shukla Date: Sat, 14 Dec 2024 07:43:19 +0530 Subject: [PATCH 1/4] docs: clearer installation instructions --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 26eb72fe..c8441f1a 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,14 @@ Maxun lets you train a robot in 2 minutes and scrape the web on auto-pilot. Web # Installation +1. First, create a file named `.env` in the root folder of the project +2. Example env file can be viewed [here](https://github.com/getmaxun/maxun/blob/master/ENVEXAMPLE). Copy all content of example env to your `.env` file. +3. Choose your installation method below + ### Docker Compose +1. Copy the `docker-compose.yml` file from the codebase +2. Ensure you have setup the `.env` file +3. Run the command below ``` docker-compose up -d ``` From eb27cddacd27c4b9bcc73c840d909ef9a2b42bb9 Mon Sep 17 00:00:00 2001 From: Karishma Shukla Date: Sat, 14 Dec 2024 07:47:03 +0530 Subject: [PATCH 2/4] docs: compose file location --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c8441f1a..38d0eebe 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@ Maxun lets you train a robot in 2 minutes and scrape the web on auto-pilot. Web 3. Choose your installation method below ### Docker Compose -1. Copy the `docker-compose.yml` file from the codebase +1. Copy paste the [docker-compose.yml file](https://github.com/getmaxun/maxun/blob/master/docker-compose.yml) 2. Ensure you have setup the `.env` file 3. Run the command below ``` From 0284f3d001536ec7128c484044fbac102647e707 Mon Sep 17 00:00:00 2001 From: amhsirak Date: Sat, 14 Dec 2024 09:27:13 +0530 Subject: [PATCH 3/4] feat: remove fe be mounts --- docker-compose.yml | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/docker-compose.yml b/docker-compose.yml index 51a9f4eb..3c6e3a0f 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -64,8 +64,6 @@ services: - redis - minio volumes: - - ./server:/app/server # Mount server source code for hot reloading - - ./maxun-core:/app/maxun-core # Mount maxun-core for any shared code updates - /var/run/dbus:/var/run/dbus frontend: @@ -79,13 +77,10 @@ services: environment: PUBLIC_URL: ${PUBLIC_URL} BACKEND_URL: ${BACKEND_URL} - volumes: - - ./:/app # Mount entire frontend app directory for hot reloading - - /app/node_modules # Anonymous volume to prevent overwriting node_modules depends_on: - backend volumes: postgres_data: minio_data: - redis_data: + redis_data: \ No newline at end of file From 6c15df78161969fdc46ea0af98fdcc19e2a5ed4f Mon Sep 17 00:00:00 2001 From: The Hague Centre for Strategic Studies <51345661+HCSS-StratBase@users.noreply.github.com> Date: Sat, 14 Dec 2024 19:46:21 +0100 Subject: [PATCH 4/4] Update README.md small addition to make the installation instructions more 'noob-proof' --- README.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 38d0eebe..b63cf8a7 100644 --- a/README.md +++ b/README.md @@ -30,14 +30,15 @@ Maxun lets you train a robot in 2 minutes and scrape the web on auto-pilot. Web # Installation -1. First, create a file named `.env` in the root folder of the project -2. Example env file can be viewed [here](https://github.com/getmaxun/maxun/blob/master/ENVEXAMPLE). Copy all content of example env to your `.env` file. -3. Choose your installation method below +1. Create a root folder for your project (e.g. 'maxun') +2. Create a file named `.env` in the root folder of the project +3. Example env file can be viewed [here](https://github.com/getmaxun/maxun/blob/master/ENVEXAMPLE). Copy all content of example env to your `.env` file. +4. Choose your installation method below ### Docker Compose -1. Copy paste the [docker-compose.yml file](https://github.com/getmaxun/maxun/blob/master/docker-compose.yml) -2. Ensure you have setup the `.env` file -3. Run the command below +1. Copy paste the [docker-compose.yml file](https://github.com/getmaxun/maxun/blob/master/docker-compose.yml) into your root folder +2. Ensure you have setup the `.env` file in that same folder +3. Run the command below from a terminal ``` docker-compose up -d ```