A Spring Boot web application that transforms documents into comprehensive FAQ formats with ease.

Doc2FAQ is designed to help users convert various types of documents (technical documentation, user manuals, knowledge base articles) into well-structured, accessible FAQ content. This application provides an intelligent way to generate questions and answers from existing documentation.

• 📄 Document upload and processing
• 🤖 Intelligent question generation
• 📋 FAQ formatting and organization
• 📤 Export capabilities in multiple formats
• 🎨 User-friendly web interface
• 🔍 Search and filter functionality

Before running this application, make sure you have the following installed:

• Java 17 or higher
• Maven 3.6+ (for building the project)
• Git (for version control)

git clone <repository-url>
cd doc2faq-app

mvn clean compile

mvn test

mvn spring-boot:run

Alternatively, you can build and run the JAR file:

mvn clean package
java -jar target/doc2faq-app-0.0.1-SNAPSHOT.jar

Once the application is running, open your web browser and navigate to:

http://localhost:8080

You should see the Doc2FAQ landing page with a welcome message and feature overview.

doc2faq-app/
├── src/
│   ├── main/
│   │   ├── java/
│   │   │   └── com/doc2faq/app/
│   │   │       ├── Doc2FaqApplication.java      # Main Spring Boot application
│   │   │       └── controller/
│   │   │           └── HomeController.java      # Landing page controller
│   │   └── resources/
│   │       ├── templates/
│   │       │   └── index.html                   # Landing page template
│   │       └── application.properties           # Application configuration
│   └── test/
│       └── java/
│           └── com/doc2faq/app/
│               └── Doc2FaqApplicationTests.java # Basic application tests
├── pom.xml                                      # Maven configuration
├── .gitignore                                   # Git ignore rules
└── README.md                                    # This file

The application uses the following default configuration:

• Server Port: 8080
• Context Path: /
• Thymeleaf Templates: Located in src/main/resources/templates/

You can modify these settings in src/main/resources/application.properties.

1. Create feature branches from main
2. Follow the existing package structure under com.doc2faq.app
3. Add appropriate tests for new functionality
4. Update documentation as needed

The application includes Spring Boot DevTools for hot reloading during development:

mvn spring-boot:run

Changes to Java files will require a restart, but template and static resource changes will be picked up automatically.

Run the test suite with:

mvn test

For integration tests:

mvn verify

To create a production-ready JAR file:

mvn clean package -Pprod

The JAR file will be created in the target/ directory.

1. Port 8080 already in use

   • Change the port in application.properties: server.port=8081
   • Or kill the process using port 8080

2. Java version issues

   • Ensure you're using Java 17 or higher
   • Check with: java -version

3. Maven build failures

   • Ensure Maven is properly installed: mvn -version
   • Clear Maven cache: mvn dependency:purge-local-repository

If you encounter issues:

1. Check the application logs for error messages
2. Verify all prerequisites are installed correctly
3. Ensure no other applications are using port 8080

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

This project is licensed under the MIT License - see the LICENSE file for details.

This application is ready for development! The next phases will include:

• Document upload functionality
• AI-powered question generation
• FAQ formatting and export features
• User authentication and management
• Advanced search and filtering capabilities

Status: ✅ Initial setup complete - Ready for development!