Merge pull request #221 from KaranRudra311/develop

docs: minor changes in readme
This commit is contained in:
Karishma Shukla
2024-12-01 22:39:19 +05:30
committed by GitHub

View File

@@ -29,7 +29,7 @@ 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" />
> Note: We are in early stages of development and do not support self hosting yet. You can run Maxun locally. > Note: Maxun is in its early stages of development and currently does not support self-hosting. However, you can run Maxun locally. Self-hosting capabilities are planned for a future release and will be available soon.
# Local Setup # Local Setup
### Docker Compose ### Docker Compose
@@ -37,6 +37,7 @@ Maxun lets you train a robot in 2 minutes and scrape the web on auto-pilot. Web
git clone https://github.com/getmaxun/maxun git clone https://github.com/getmaxun/maxun
docker-compose up -d docker-compose up -d
``` ```
You can access the frontend at http://localhost:5173/ and backend at http://localhost:8080/
### Without Docker ### Without Docker
1. Ensure you have Node.js, PostgreSQL, MinIO and Redis installed on your system. 1. Ensure you have Node.js, PostgreSQL, MinIO and Redis installed on your system.