chore: local setup
This commit is contained in:
23
README.md
23
README.md
@@ -25,6 +25,29 @@ 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
|
||||||
|
### Docker
|
||||||
|
|
||||||
|
### Local Setup
|
||||||
|
1. Ensure you have Node.js, PostgreSQL, MinIO and Redis installed on your system.
|
||||||
|
2. Run the commands below:
|
||||||
|
```
|
||||||
|
git clone https://github.com/getmaxun/maxun
|
||||||
|
|
||||||
|
# change directory to the project root
|
||||||
|
cd maxun
|
||||||
|
|
||||||
|
# install dependencies
|
||||||
|
npm install
|
||||||
|
|
||||||
|
# change directory to maxun-core to install dependencies
|
||||||
|
cd maxun-core
|
||||||
|
npm install
|
||||||
|
|
||||||
|
# start frontend and backend together
|
||||||
|
npm run start
|
||||||
|
```
|
||||||
|
You can access the frontend at http://localhost:5173/ and backend at http://localhost:8080/
|
||||||
|
|
||||||
|
|
||||||
# Envirnoment Variables
|
# Envirnoment Variables
|
||||||
| Variable | Mandatory | Description | If Not Set |
|
| Variable | Mandatory | Description | If Not Set |
|
||||||
|
|||||||
Reference in New Issue
Block a user