vodorod/parcer
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source 
small addition to make the installation instructions more 'noob-proof'
This commit is contained in:
The Hague Centre for Strategic Studies
2024-12-14 19:46:21 +01:00
committed by GitHub
parent 6b1b0d3688
commit 6c15df7816
1 changed files with 7 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@@ -30,14 +30,15 @@ Maxun lets you train a robot in 2 minutes and scrape the web on auto-pilot. Web
<img src="https://static.scarf.sh/a.png?x-pxid=c12a77cc-855e-4602-8a0f-614b2d0da56a" /> <img src="https://static.scarf.sh/a.png?x-pxid=c12a77cc-855e-4602-8a0f-614b2d0da56a" />
# Installation # Installation
1. First, create a file named `.env` in the root folder of the project 1. Create a root folder for your project (e.g. 'maxun')
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. 2. Create a file named `.env` in the root folder of the project
3. Choose your installation method below 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 ### Docker Compose
1. Copy paste the [docker-compose.yml file](https://github.com/getmaxun/maxun/blob/master/docker-compose.yml) 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 2. Ensure you have setup the `.env` file in that same folder
3. Run the command below 3. Run the command below from a terminal
``` ```
docker-compose up -d docker-compose up -d
``` ```