Project Setup

This guide provides comprehensive instructions to set up your development environment for the Sprint 5 Challenge. Proper setup is crucial for successfully implementing the project requirements, focusing on functional requirements, debugging, testing, and memory management.

Setup Steps

Clone the starter repository: git clone https://github.com/BloomTechBackend/bd-intermediate-java-project.git
Download the CLI JAR file from the second repository (store it separately)
Import the project into your IDE
Set up the project dependencies
Verify the project setup by running the initial tests

1. Clone the Repository

Open your terminal or command prompt and navigate to your preferred directory. Then execute:

git clone https://github.com/BloomTechBackend/bd-intermediate-java-project.git
cd bd-intermediate-java-project

2. Download the CLI JAR

The CLI JAR contains tools needed to interact with the application:

Visit the CLI JAR repository
Download the latest JAR file from the Releases section
Store it in a separate directory from your project (e.g., in a "tools" folder)

3. Import into Your IDE

The project uses Maven for dependency management:

IntelliJ IDEA: File → Open → Select the project's pom.xml → Open as Project
Eclipse: File → Import → Maven → Existing Maven Projects → Select the project directory
VS Code: Open folder and select the project directory, ensure Maven extension is installed

4. Set Up Dependencies

The project uses Maven to manage dependencies. Let your IDE import all required dependencies automatically, or run:

mvn clean install

Ensure you have Java 11 or higher configured in your IDE.

5. Verify Setup

Run the initial tests to ensure everything is set up correctly:

Navigate to the src/test/java directory
Find the SetupTest.java file
Right-click and select "Run Test" or "Run SetupTest.java"

If all tests pass, your environment is correctly configured!

Troubleshooting Common Issues

Maven Dependency Issues
If Maven fails to download dependencies, try:
```
mvn clean install -U
```
The -U flag forces Maven to update snapshots and check for newer versions.
Java Version Mismatch
Ensure you're using Java 11 or higher. Check your Java version with:
```
java -version
```
Configure your IDE to use the correct JDK version for the project.
Test Failures
If initial tests fail, check the error messages for specific issues. Common problems include:
- Missing environment variables (check application.properties)
- Incorrect path to the CLI JAR file
- Conflicting dependencies
IDE Configuration
Ensure your IDE is configured to recognize the project structure:
- src/main/java should be marked as Sources Root
- src/test/java should be marked as Test Sources Root
- src/main/resources should be marked as Resources Root

← Back to Guided Projects

Sprint 5 Challenge Setup