The INSTALL.txt file should contain all information needed to install and run your code, from scratch, on a lab machine, including:
- Pre-conditions
- Hardware, peripherals, and operating system restrictions for running your code ( i.e., can this code only run on lab machines, or can it run elsewhere?)
- All code should run on our lab computers, unless you have an exemption from the instructor.
- If some of your features work more efficiently on specific hardware, please explain this here.
Pre-conditions
- Hardware and OS Requirements:
- The application runs on lab computers equipped with CentOS. It is cross-platform and compatible with any system that supports Java 17.
- Supporting files
- A list of non-standard libraries needed for your project to run, including:
- Clear and simple instructions for how to freely (and legally!) acquire and install them from source code with minimal effort.
- You may additionally link to a binary version of the libraries, if you wish.
- Examples of how to use your project
- Several clear examples the illustrate the main features of your project.
- Descriptions of testing patterns, and instructions on how to exercise them:
- unit tests
- system tests
- Java Requirement:
- Java JDK 17 is required.
- Execution
- Clear and terse instructions on how an average student in the class can compile and run all your code, from scratch, on a lab machine.
No newline at end of file
Supporting Files
- External Libraries:
- Jsoup: For HTML parsing.
Installation Instructions
- Install Java JDK 17:
- Follow the download and installation instructions from Oracle's website (https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html)
- Set up JAVA_HOME and update your system's PATH.
- Install Maven:
- Download and install via Maven (https://maven.apache.org/download.cgi)
- Follow the detailed installation instructions on the Maven website.
- Ensure Maven's bin directory is in your system's PATH.
- 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:
- 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.
- Select a module from the drop-down menu (Crawler, Checker, or Corrector).
- Enter a URL or a local file path in the text field.
