PastoralSearch

Searching for specific content in PowerPoint files can be tricky on locked down machines. PPDiscover is made to make it possible to find hymns used in previous sermons easily.

PPDiscover is a full-stack application consisting of a Java Spring Boot backend and a Vue.js frontend. The application requires a Solr instance with a configured 'ppdiscover' collection for data storage and search functionality.

Project Structure

PastoralSearch/
├── PastoralSearch-backend/              # Backend (Java Spring Boot)
│   ├── src/                 # Source code
│   ├── pom.xml             # Maven dependencies
│   └── Dockerfile          # Backend container configuration
│
├── PastoralSearch-frontend/     # Frontend (Vue.js)
│   ├── src/                # Source code
│   ├── package.json        # NPM dependencies
│   └── Dockerfile          # Frontend container configuration
│
├── docker-compose.yml       # Docker Compose configuration
├── .gitignore              # Git ignore rules
└── CHANGELOG.md            # Project changelog

Prerequisites

• Docker and Docker Compose
• Java 21 (for local development)
• Node.js 18+ (for local development)
• Maven (for local development)
• Solr 8+ with a configured 'ppdiscover' collection (Solr 9 is recommended)

Getting Started

Using Docker (Recommended)

1. Clone the repository:

   git clone <repository-url>
   cd PPDiscover-parent

2. Build and start the containers:

   docker-compose up --build

3. Access the application:

   • Frontend: http://localhost:3000
   • Backend: http://localhost:9070

Local Development

Backend

1. Navigate to the backend directory:

   cd PPDiscover

2. Build and run using Maven:

   mvn clean install
   mvn spring-boot:run

Frontend

1. Navigate to the frontend directory:

   cd PPDiscover-frontend

2. Install dependencies and run:

   npm install
   npm run dev

Development

Backend Development

The backend is built with:

• Java 21
• Spring Boot
• Maven
• Solr for search

Frontend Development

The frontend is built with:

• Vue.js
• Node.js
• Vite

Contributing

1. Create a new branch for your feature
2. Make your changes
3. Submit a pull request

Versioning

This project follows Semantic Versioning. For the versions available, see the CHANGELOG.md.

License

[Add your license here]