This guide will walkthrough the steps necessary to setup the project for the first time. Once setup, the same project will be used for all of the Projects assignments.

<aside> <img src="/icons/preview_gray.svg" alt="/icons/preview_gray.svg" width="40px" /> There is a walkthrough video of these steps, but it is for an older version of Java and tests. The process, however, is similar!

</aside>

TABLE OF CONTENTS

Summary

The project is broken into two separate GitHub repositories and Eclipse projects:

• SearchEngine: This is where you will place your project code. You will have your own private version of this project. The initial template includes some configuration files and a skeleton Driver.java class. The repo will be named project-[username] where [username] is your GitHub username (not your USF username).
• SearchEngineTest: This is where the project tests files and expected output files are located. Everyone shares the same read-only repository. It will start with the Project 1 Index test files first and will be updated throughout the semester with new test files for the other projects. The repo will be named project-tests for everyone.

You will reuse these same repositories for all of the projects.

When we verify the functionality and review the design of your project, we will only checkout the SearchEngine repository each time. This helps avoid having to re-copy the large test files over and over again.

You can use the Importing Eclipse Projects from GitHub guide to import both of these repositories, but it is critical that the underlying repositories are stored in the same parent folder.

Create and Import Projects

Below is a summary of the one-time setup needed for the project:

1. Visit the GitHub Classroom link below to setup a private repository named project-username where username is your GitHub username. You will use this same repository the entire semester for all of the projects.

2. NEW: On GitHub, create a release with the tag v0.0.0 exactly. This will force the GitHub Action workflows to show up for the first time.

   

3. Import the repository as a Java Project in Eclipse. See the Importing Eclipse Projects from GitHub guide for steps. This will create a “SearchEngine” project in Eclipse where you will add your own code for the project.

4. Import the project-tests repository below as a Java Project in Eclipse. This will create a “SearchEngineTests” project in Eclipse where you will find all of the test code and data files.

   https://github.com/usf-cs272n-fall2024/project-tests

   ⚠️ These two projects must be located in the same parent directory!