Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/asyylz/final_project

Welcome to Worksheet Generator Application. This application automates worksheet generation, saving both time and effort while ensuring high-quality, customizable content.
https://github.com/asyylz/final_project

css docker fxml java javafx-desktop-apps

Last synced: 3 months ago
JSON representation

Welcome to Worksheet Generator Application. This application automates worksheet generation, saving both time and effort while ensuring high-quality, customizable content.

Awesome Lists containing this project

README 

          



    
Worksheet Generator Application


    
The application is designed to assist parents and tutors in preparing

        students for the 11+ GL exam by generating tailored practice worksheets.



    
Table of Contents


    



    
1-Features


    
Key features covered in this repository:


    
    

            
  • 

    User Authentication: Secure login and registration system for users, ensuring that only

                authorized users can access the platform.

            
    • 

            
  • 

    Main Subject and Sub Subject Selection: Allows users to choose from a variety of main

                subjects and their corresponding sub-subjects for customized content generation or activities.

            
    • 

            
  • 

    Difficulty Level of Sheets: Users can select the difficulty level of worksheets to match

                their skill and experience, providing a personalized challenge.

            
    • 

            
  • 

    Interactive Answer and Score Check: Provides instant feedback on user answers, with a score

                check display.

            
    • 

            
  • 

    Locking Answers with Pin: Adds a layer of security by allowing users to lock their answers

                with a pin code and set a timer for completing tasks, creating a controlled environment for assessments or

                exercises.

            
    • 

            
  • 

    Setting Timer: Setting a timer for completing tasks, creating a controlled environment for

                assessments or exercises.

            
    • 

            
  • 

    Responsive Design: Ensures a seamless and optimized user experience.
    • 

            
  • 

    Singleton (UI Layer) Ensures that only one instance of a UI manager (or a similar component) exists throughout the application's lifecycle. Helps in managing global UI state efficiently.
    • 

            
  • 

    Observer (UI Notifications) Implements a publisher-subscriber model to notify the UI of state changes dynamically. Ensures decoupling between data sources and UI components, improving responsiveness
    • 

        



    
2-Technologies


    
    

            
  • 

    JavaFX: A framework for building rich desktop applications using Java. Provides tools for

                creating user interfaces with modern graphics, animations, and more.

            
    • 

            
  • 

    OpenAI API (gpt-3.5-turbo): Used to generate worksheet content dynamically, create tailored

                questions, answers, and explanations based on the selected subjects and difficulty levels.

            
    • 

            
  • 

    MS SQL Server: A relational database management system used for storing and managing

                application data, ensuring efficient data storage and retrieval.

            
    • 

        



    
3-Development Tools


    
    

            
  • 

    IntelliJ IDEA: A powerful Integrated Development Environment (IDE) for Java and other

                languages, used for efficient coding, debugging, and project management.

            
    • 

            
  • 

    Mockito: A popular testing framework for Java that allows for easy creation of mock objects

                in unit tests, making it simpler to isolate and test specific parts of the application.

            
    • 

        



    
4-Getting Started


    
To get started with the repository, follow these steps:


    
Installation


    
    

            
  1. 

                
    Clone
    

            Clone the repository to your local machine using the following command:
    2. 

            

    git clone https://github.com/asyylz/Final_Project

            
    

            
  2. 

                
    Environment Variables
    

            Set up your environment variables: Create a `.env` file at the root level (same level as the `src`

            directory) and add the following variables:

                
      

                      
    1. API_KEY -> Should be created
      2. 

                      
    2. API_URL -> https://api.openai.com/v1/chat/completions
      3. 

                      
    3. SQLSERVER_URL_DB -> jdbc:sqlserver://localhost;database=WorksheetGeneratorApp
      4. 

                      
    4. SQLSERVER_USER -> SA
      5. 

                      
    5. SQLSERVER_PASSWORD -> Should be created
      6. 

                  
    

            
    3. 

            
  3. 

                
    Docker Setup for Development & Deployment
    

                
    This section explains how to set up your environment using Docker for both development and deployment (EXE mode). Docker is used to create isolated environments,

                    which makes it easy to run the application and its dependencies consistently.
    


    

                
      

                      
    1. 

                          
      First, ensure that you're in the correct directory, where the docker-compose.yml and related files are located:
      

                              
      cd WorksheetGenerator
      

                      
      2. 


      

                      
    2. 

                          
      To create the Docker image and start the related containers, run the following command. This will build the Docker image and start the 

                          containers in detached mode (-d):
      

                        
      docker-compose up --build -d
        

                      
      3. 


      

                      
    3. 

                          
      Once the containers are up and running, you can verify that the WorksheetGeneratorApp database has been created inside the container.

                          To do this, execute the following command. This will open an interactive shell inside the container.
      

      docker exec -it wgapp-database-container bash
      

                      
      4. 


      

                      
    4. 

                          
       Now, you are inside the container. Run the following command to list all databases:
      

      /opt/mssql-tools18/bin/sqlcmd -S localhost -U SA -P "${SQLSERVER_PASSWORD}" -Q "SELECT name FROM sys.databases" -C
          

                      
      5. 


      

                      
      You should see a list of databases, and WorksheetGeneratorApp should be present in the list of databases.
      

                      
      

                  

                  

      name

      -------------------------------

      master

      tempdb

      model

      WorksheetGeneratorApp

                        

                      
      

                      
      

    5. 

      You exit  from container  by typing container's bash exit:
      

                  
      exit
      


      6. 

    6. 

          
      To stop container:
      

            
      docker stop wgapp-database-container
      

      To start again container:
      

            
      docker start wgapp-database-container
      

      7. 

    7. 

          
      Run application with App.java file.
      

      8. 

                  
    

            
    4. 

        



   
5-Introductory Video


Link: Watch Video



    
6-Application


6.1. Upon launching the application, you will be greeted with the login window.Login Credentials for testing.

After clicking Let's start button user will be directed main window with generation content.



    
username: testUser


        password: passW@rd

    




  &nbsp &nbsp &nbsp &nbsp &nbsp






6.2. User can start worksheet generation on generation section on main window by selecting all necessary fields.Once all necessary fields selected generation button will be activated. If user chooses english paper with comprehension (spag, vocabulary,cloze etc) as sub topic passage addition button will appear. User should add a passage and a title for passage. You can clear out all selections by clicking clear selection button and start a new one.





  &nbsp &nbsp &nbsp &nbsp &nbsp






6.3. Once generation is complete, the worksheet section will appear, and the UI will update with the newly generated worksheet. Users can interact with the worksheet in this section, including deleting it, setting a timer, or searching by passage title. However, the search feature is not available for math papers. The 'Show Answers' button will also be activated, but it requires unlocking with a PIN.


User also can download worksheet in PDF format by clicking download button. Exit from program clicking on red exit button.





  &nbsp &nbsp &nbsp &nbsp &nbsp






6.4. Users can view a list of worksheets they previously generated in the history section. Here, they can delete a worksheet or open and view it in the worksheet section.
In the account section, users can update their password and PIN. By default, all registered users have a PIN set to (0000).



 


 &nbsp &nbsp &nbsp &nbsp &nbsp

 





    
7-Documentation


    



    



    
8-Contributing


    
Contributions to the project are welcome! If you find any issues or have suggestions for improvements, please

        feel free to open an issue or submit a pull request.


    
9-License


    
This project is licensed under the MIT License.