Getting Started

To get a local copy up and running, follow these simple steps.

Prerequisites

Ensure you have the following installed on your system:

• Java JDK 21+ (Backend requirement)
• Node.js 18+ (Frontend requirement)
• PostgreSQL 15+ (Database)
• Maven (Optional, wrapper provided)
• npm or yarn (Package manager for frontend)

Installation

1. Clone the repo

   git clone https://github.com/HKH-soft/Netpick.MailMine.git

   CopyCopied!

2. Backend Setup

   cd Backend# Configure database in src/main/resources/application.yml# Update PostgreSQL connection settings./mvnw spring-boot:run

   CopyCopied!

   The backend API will be available at http://localhost:8080

3. Frontend Setup

   cd Frontendnpm install# Configure API endpoint if needednpm run dev

   CopyCopied!

   The frontend will be available at http://localhost:3000

4. Database Setup

   • Create a PostgreSQL database named mailmine
   • Update Backend/src/main/resources/application.yml with your database credentials
   • Flyway migrations will run automatically on startup

5. Access the App Open your browser and navigate to http://localhost:3000.

Usage

Secure Sign In

Access your dashboard securely. The system supports persistent login sessions.

Managing Scrape Pipelines

1. Navigate to the Scrape section.
2. Then in Control select what part of the scraping you want to start.
3. Monitor the progress in real-time on the dashboard.