Commit a4c9b424 authored by Manuel Segimon's avatar Manuel Segimon
Browse files

Merge branch '20-add-executables' into 'master' 

Resolve "Add Executables"

Closes #20

See merge request ec504/ec504_projects/group7!14
parents 0af524fc 48f952f7

INSTALL.txt

+23 −15
Original line number Diff line number Diff line
@@ -24,18 +24,26 @@ Installation Instructions 
  - Setup Project:

    - Download or clone the project repository.

    - Navigate to the project directory (where pom.xml is located).

    - Run mvn clean install to resolve dependencies and build the project.



Execution Instructions

  - Launch the application:

CLI Execution Instructions

  - Open a terminal.

    - Change to the directory containing the project's compiled classes.

    - Run the application using Maven.



Usage Examples

  - Starting the Application:

    - Execute the application as per the instructions above.

  - Move into the project directory.

  - Run `chmod +x *.sh` if you have not done so already.

  - Run the modules separately using the following bash scripts:

    - `./crawlerCLI.sh $arguments`

      - `--file crawler_test_file.txt`, the file contains a list of links and the crawler will add content from these links to the trie.

      - `--build [en, gr, it, or gr]`, this will build the trie based on the text corpus for each language.

      - `--social [reddit URL]`, this will add content from a reddit post to the trie.

    - `./checkerCLI.sh --file checker_test_file.txt`

    - `./correctorCLI.sh --file checker_test_file.txt`



Visual GUI Execution Instructions

  - Open a terminal.

  - Move into the project directory.

  - Run `chmod +x *.sh` if you have not done so already.

  - Run `./runVisual.sh`, to both build and execute the application.

  - Select a module from the drop-down menu (Crawler, Checker, or Corrector).

    - Enter a URL or a local file path in the text field.

  - For Crawler enter a URL or a local file path in the text field.

  - For Checker and Corrector enter a string of text or a local file path in the text field.

  - Click Run to execute the selected module.

    - Have fun!!!
 
  - If you want to change language close the application and run `./runVisualNewLanguage.sh`

README.md

+3 −1
Original line number Diff line number Diff line
@@ -183,7 +183,7 @@ Worked on Crawler Module: implemented data compression and storage. 
Worked on GUI Feature: implemented UI to wrap everything together, allow for user inputs (URL processing, file system inputs, module selection), and real-time feedback to users (part of another feature).



### Manuel Segimón 

Built initial checker module using statisical methods

Built initial checker module using statistical methods



Implemented TrieNode structure for crawler to use ngrams and track conditional probabilities
@@ -197,6 +197,8 @@ Implemented GUI for correcter 


Found and generated text corpses for german, italian and portuguese (From: https://wortschatz.uni-leipzig.de/en/download/German)



Added executables to the project so that reviewers can easily run the program and wrote execution instructions to INSTALL.txt



### Tejas Singh

Worked on base functionality of crawler: implemented Jsoup, basic data structures (such as the URL queue), and CLI (for use with files).

checkerCLI.sh

0 → 100755
+2 −0
Original line number Diff line number Diff line 
mvn clean install

java -cp "jsoup-1.17.2.jar:target/classes/" edu.bu.LanguageCorrection.Checker $1 $2 $3 $4 $5 $6 $7 $8 $9
 
 No newline at end of file

correctorCLI.sh

0 → 100755
+2 −0
Original line number Diff line number Diff line 
mvn clean install

java -cp "jsoup-1.17.2.jar:target/classes/" edu.bu.LanguageCorrection.Corrector $1 $2 $3 $4 $5 $6 $7 $8 $9
 
 No newline at end of file

crawlerCLI.sh

0 → 100755
+2 −0
Original line number Diff line number Diff line 
mvn clean install

java -cp "jsoup-1.17.2.jar:target/classes/" edu.bu.LanguageCorrection.crawler $1 $2 $3 $4 $5 $6 $7 $8 $9
 
 No newline at end of file