https://github.com/SzymonKubica/advent-of-code
A repository containing solutions of the advent of code challenges in 2023 written in rust and python
https://github.com/SzymonKubica/advent-of-code
Last synced: 19 days ago
JSON representation
A repository containing solutions of the advent of code challenges in 2023 written in rust and python
- Host: GitHub
- URL: https://github.com/SzymonKubica/advent-of-code
- Owner: SzymonKubica
- Created: 2023-11-30T17:23:04.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-04-13T11:48:57.000Z (about 2 months ago)
- Last Synced: 2025-04-13T12:20:40.996Z (about 2 months ago)
- Language: Java
- Size: 6.73 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Advent of Code Playground
This repository contains my solutions for AoC for the past few years. The
codebase is set up to allow for implementing solutions in different languages
and then using a single executable in the root of this repo to execute them.
## Structure of the Codebase
The structure of the project is as follows:
```
.
├── 2023
│ ├── input-files
│ ├── python
│ └── rust
│ ...
├── 2024
│ ├── cpp
│ ├── elixir
│ ├── input-files
│ └── rust
│ ...
├── README.md
├── runner
└── utils
```
In the directories corresponding to the yearly solutions, each of the folders
is contains solutions implemented in the specific language.
Each of these directories is a separate project that exposes a single
executable script `run` which can be used to run solutions to the daily
challenges.
An example command line using that run script can be seen below:
```shell
./run.sh 12 1 ../inputs/day12
```
The arguments above in order specify the day for which to run the solution,
the part of the puzzle that is to be executed and optional path to the input
file. If the input file is not provided, the script runner script will default
to sourcing its input from the file under:
```
.//input-files/day--puzzle-input
```
The run script should pass the supplied arguments to the implementation in the
target language. The solution should then print all of its logs to stdout /
stderr and the final solution of the puzzle should be logged there as well.
The runner script will then stream the output to the console as is appears
as well as capture it so that it can later be saved in a specified file.
## Setup instructions
Prerequisites:
- you have cloned this repo to your local machine
- you have installed [all of the stuff](https://www.rust-lang.org/tools/install)
that is required for compiling `rust` programs
1. Build the `runner script by executing the build script:
```shell
build.sh
```
2. Source the setup script that will alias the runner build output and set up
your environment:
```shell
source setup.sh
```
3. Now you can use the `runner` script to execute the solutions like so:
```shell
runner --year 2024 --day 1 --part 2 --language rust
```
4. For languages that require compilation, you can specify the `--build` flag
to ensure that the `runner` builds the latest version of the solutions project.
```shell
runner --year 2024 --day 1 --part 2 --language java --build
```
## Onboarding a new language
1. Create a new folder with the name of your new language in the directory
corresponding to the year for which you want to add solutions. Example:
when adding solutions for c++, one can create a new directory under
`2024/cpp`
2. Set up the `run.sh` and `build.sh` scripts (you can look at existing directories
for reference). Important:
- `build.sh` should compile all of your solutions (if your chosen language
requires compilation)
- `run.sh` runs your solutions for requested day and part, like so:
```shell
./run.sh 12 1 ../inputs/day12
```
3. You can now use the main `runner` script to build and execute your solutions, e.g:
```shell
runner --year 2024 --day 1 --part 2 --language cpp --build
```