Skip to content

Commit

Permalink
docs: add readme and license
Browse files Browse the repository at this point in the history
  • Loading branch information
gventuri committed Sep 23, 2024
1 parent f3ddd0f commit 59b0b30
Show file tree
Hide file tree
Showing 2 changed files with 138 additions and 0 deletions.
25 changes: 25 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
Copyright (c) 2024 Sinaptik GmbH

Portions of this software are licensed as follows:

- All content that resides under the "ee/" directory of this repository, if that directory exists, is licensed under the license defined in "ee/LICENSE".
- All third party components incorporated into the PostHog Software are licensed under the original license provided by the owner of the applicable component.
- Content outside of the above mentioned directories or restrictions above is available under the "MIT Expat" license as defined below.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
113 changes: 113 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,113 @@
# 🐼 PandaETL

PandaETL is an open-source, no-code ETL (Extract, Transform, Load) tool designed to extract and parse data from various document types including PDFs, emails, websites, audio files, and more. With an intuitive interface and powerful backend, PandaETL simplifies the process of data extraction and transformation, making it accessible to users without programming skills.

## ✨ Features

- **πŸ“ No-Code Interface**: Easily set up and manage ETL processes without writing a single line of code.
- **πŸ“„ Multi-Document Support**: Extract data from PDFs, emails, websites, audio files, and more.
- **πŸ”§ Customizable Workflows**: Create and customize extraction workflows to fit your specific needs (coming soon).
- **πŸ”— Extensive Integrations**: Integrate with various data sources and destinations (coming soon).
- **πŸ’¬ Chat with Documents**: Chat with your documents to retrieve information and answer questions (coming soon).

## πŸš€ Getting Started

### πŸ“‹ Prerequisites

- Node.js
- yarn
- Python (for backend)
- Poetry (for Python dependency management)

### πŸ–₯️ Frontend Setup

1. Clone the repository:

```bash
git clone https://github.com/yourusername/pandaetl.git
cd pandaetl/frontend
```

2. Install dependencies:

```bash
yarn install
```

3. Run the development server:

```bash
yarn dev
```

4. Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.

### πŸ› οΈ Backend Setup

1. Navigate to the backend directory:

```bash
cd ../backend
```

2. Create an environment file from the example:

```bash
cp .env.example .env
```

3. Install dependencies:

```bash
poetry install
```

4. Apply database migrations:

```bash
make migrate
```

5. Start the backend server:
```bash
make run
```

## πŸ“š Usage

### πŸ†• Creating a New Project

1. Navigate to the "Projects" page.
2. Click on "New Project".
3. Fill in the project details and click "Create".

### βš™οΈ Setting Up an Extraction Process

1. Open a project and navigate to the "Processes" tab.
2. Click on "New Process".
3. Follow the steps to configure your extraction process.

### πŸ’¬ Chat with Your Documents (Coming Soon)

Stay tuned for our upcoming feature that allows you to chat with your documents, making data retrieval even more interactive and intuitive.

## 🀝 Contributing

We welcome contributions from the community. To contribute:

1. Fork the repository.
2. Create a new branch for your feature or bugfix.
3. Commit your changes and push to your fork.
4. Create a pull request with a detailed description of your changes.

## πŸ“œ License

This project is licensed under the MIT Expat License. See the [LICENSE](LICENSE) file for details.

## πŸ™ Acknowledgements

We would like to thank all the contributors and the open-source community for their support.

## πŸ“ž Contact

For any questions or feedback, please open an issue on GitHub.

0 comments on commit 59b0b30

Please sign in to comment.