https://github.com/dave-burke/advent-of-code-java-starter

A project to get you started solving Advent of Code puzzles in Java
https://github.com/dave-burke/advent-of-code-java-starter

Last synced: 3 months ago
JSON representation

A project to get you started solving Advent of Code puzzles in Java

• Host: GitHub
• URL: https://github.com/dave-burke/advent-of-code-java-starter
• Owner: dave-burke
• Created: 2018-11-30T11:47:05.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2024-05-14T18:17:00.000Z (6 months ago)
• Last Synced: 2024-06-29T00:43:02.760Z (4 months ago)
• Language: Java
• Size: 102 KB
• Stars: 6
• Watchers: 2
• Forks: 12
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-advent-of-code - dave-burke/advent-of-code-java-starter

README

        
# Advent of Code Java Starter project

A project to get you started solving [Advent of Code](https://adventofcode.com/) challenge in Java.

## Architecture

The `Main` method in `App` will execute the code for a given day based on input in `src/main/resources/day[number].txt`

The given `Day` class will process the input and return a result, which `App` will print to `stdout`.

## Assumptions

1. Each day's puzzle will have an input consisting of one or more lines of plain text.

1. Each day's puzzle will have two "parts" requiring separate implementations, but using the same input.

1. Puzzle solutions will be a single line of text.

1. Each puzzle description will provide at least one example input/output.

## How to add a puzzle

The shell for day 1 is already there. These are the steps to add day 2, etc. For day 1 you can start by writing the test cases once the puzzle posts.

### Part 1

1. Create `aoc.day02.Day02.java implements Day`

1. Add a line to the static initialization block in `App.java` to add your nwe `Day` implementation: `DAYS.put(2, new Day02())`

1. Create `Day02Test.java` and use the sample input/output from adventofcode.com/2019/day/2 to write tests (they will initially fail).

1. Implement `Day02.part1()` until the tests pass (Test Driven Development!). You can run `./gradlew --continuous check` to have the tests run every time you save your code.

1. When the example input passes, get your solution from adventofcode.com/2019/day/2/input and save it as `src/main/resources/day02.txt`

1. Run `./gradlew clean build install && ./build/install/advent-of-code/bin/advent-of-code 2` to get your output.

    - Notice the day number ("2") is passed to the start script as an argument.

1. Check your solution on adventofcode.com!

### Part 2

1. Add new tests for part 2 to `Day02Test.java` using the sample input/output from adventofcode.com/2019/day/2

1. Implement `Day02.part2()` until the tests pass.

1. When the example input passes, run `./gradlew clean build install && ./build/install/advent-of-code/bin/advent-of-code 2 2` to get your output.

    - Notice the second argument to the script is the part number. It defaults to 1, so now you have to pass it as 2.

1. Check your solution on adventofcode.com!