116 lines
5.3 KiB
Markdown
116 lines
5.3 KiB
Markdown
<h2 align="center">
|
||
<div>
|
||
<a href="https://www.maxun.dev/?ref=ghread">
|
||
<img src="/src/assets/maxunlogo.png" width="70" />
|
||
<br>
|
||
Maxun
|
||
</a>
|
||
</div>
|
||
The Easiest Way To Extract Web Data With No Code <br>
|
||
</h2>
|
||
|
||
<p align="center">
|
||
Maxun lets you train a robot in 2 minutes and scrape the web on auto-pilot. Web data extraction doesn't get easier than this!
|
||
</p>
|
||
|
||
|
||
<p align="center">
|
||
<a href="https://app.maxun.dev/?ref=ghread"><b>Go To App</b></a> •
|
||
<a href="https://docs.maxun.dev/?ref=ghread"><b>Documentation</b></a> •
|
||
<a href="https://www.maxun.dev/?ref=ghread"><b>Website</b></a> •
|
||
<a href="https://discord.gg/5GbPjBUkws"><b>Discord</b></a> •
|
||
<a href="https://www.youtube.com/@MaxunOSS?ref=ghread"><b>Watch Tutorials</b></a>
|
||
<br />
|
||
<br />
|
||
<a href="https://trendshift.io/repositories/12113" target="_blank"><img src="https://trendshift.io/api/badge/repositories/12113" alt="getmaxun%2Fmaxun | Trendshift" style="width: 250px; height: 55px; margin-top: 10px;" width="250" height="55"/></a>
|
||
</p>
|
||
|
||
https://github.com/user-attachments/assets/c6baa75f-b950-482c-8d26-8a8b6c5382c3
|
||
|
||
### Getting Started
|
||
The simplest & fastest way to get started is to use the hosted version: https://app.maxun.dev. You can self-host if you like!
|
||
|
||
### Installation
|
||
Maxun can run locally with or without Docker
|
||
1. [Setup with Docker Compose](https://docs.maxun.dev/installation/docker)
|
||
2. [Setup without Docker](https://docs.maxun.dev/installation/local)
|
||
3. [Environment Variables](https://docs.maxun.dev/installation/environment_variables)
|
||
|
||
### Upgrading & Self Hosting
|
||
1. [Self Host Maxun With Docker & Portainer](https://docs.maxun.dev/self-host)
|
||
2. [Upgrade Maxun With Docker Compose Setup](https://docs.maxun.dev/installation/upgrade#upgrading-with-docker-compose)
|
||
3. [Upgrade Maxun Without Docker Compose Setup](https://docs.maxun.dev/installation/upgrade#upgrading-with-local-setup)
|
||
|
||
### How Does It Work?
|
||
Maxun lets you create custom robots which emulate user actions and extract data. A robot can perform any of the actions: Capture List, Capture Text or Capture Screenshot. Once a robot is created, it will keep extracting data for you without manual intervention.
|
||
1. Capture List: Useful to extract structured and bulk items from the website.
|
||
2. Capture Text: Useful to extract individual text content from the website.
|
||
3. Capture Screenshot: Get fullpage or visible section screenshots of the website.
|
||
|
||
### Sponsors
|
||
<table>
|
||
<tr>
|
||
<td width="229">
|
||
<br/>
|
||
<a href="https://www.lambdatest.com/?utm_source=maxun&utm_medium=sponsor" target="_blank">
|
||
<img src="https://github.com/user-attachments/assets/904dd40e-0498-47dd-98f1-7fa6d318adb9" /><br/><br/>
|
||
<b>LambdaTest</b>
|
||
</a>
|
||
<br/>
|
||
<sub>GenAI-powered Quality Engineering Platform that empowers teams to test intelligently, smarter, and ship faster.</sub>
|
||
</td>
|
||
<td width="250">
|
||
<a href="https://app.cyberyozh.com/?utm_source=github&utm_medium=maxun" target="_blank">
|
||
<img src="https://github.com/user-attachments/assets/c0ae7929-003a-4e1e-b23b-d174ac0aba4f" /><br/>
|
||
<b>CyberYozh App</b>
|
||
</a>
|
||
<br/>
|
||
<sub>Infrastructure for developers working with multi‑accounting & automation in one place.</sub>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
|
||
### Features
|
||
- ✨ Extract Data With No-Code
|
||
- ✨ Handle Pagination & Scrolling
|
||
- ✨ Run Robots On A Specific Schedule
|
||
- ✨ Turn Websites to APIs
|
||
- ✨ Turn Websites to Spreadsheets
|
||
- ✨ Adapt To Website Layout Changes
|
||
- ✨ Extract Behind Login
|
||
- ✨ Integrations
|
||
- ✨ MCP
|
||
|
||
### Use Cases
|
||
Maxun can be used for various use-cases, including lead generation, market research, content aggregation and more.
|
||
View use-cases in detail here: https://www.maxun.dev/#usecases
|
||
|
||
### Screenshots
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
### Note
|
||
This project is in early stages of development. Your feedback is very important for us - we're actively working on improvements. </a>
|
||
|
||
### License
|
||
<p>
|
||
This project is licensed under <a href="./LICENSE">AGPLv3</a>.
|
||
</p>
|
||
|
||
### Support Us
|
||
Star the repository, contribute if you love what we’re building, or [sponsor us](https://github.com/sponsors/amhsirak).
|
||
|
||
### Contributors
|
||
Thank you to the combined efforts of everyone who contributes!
|
||
|
||
<a href="https://github.com/getmaxun/maxun/graphs/contributors">
|
||
<img src="https://contrib.rocks/image?repo=getmaxun/maxun" />
|
||
</a>
|