https://github.com/2wndrhs/aoc-2024-typescript-template
Advent of Code 2024 TypeScirpt Template
https://github.com/2wndrhs/aoc-2024-typescript-template
Last synced: 29 days ago
JSON representation
Advent of Code 2024 TypeScirpt Template
- Host: GitHub
- URL: https://github.com/2wndrhs/aoc-2024-typescript-template
- Owner: 2wndrhs
- License: other
- Created: 2024-12-04T13:09:31.000Z (6 months ago)
- Default Branch: master
- Last Pushed: 2024-12-21T10:25:31.000Z (5 months ago)
- Last Synced: 2025-04-24T03:15:55.440Z (29 days ago)
- Language: TypeScript
- Homepage:
- Size: 38.1 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-advent-of-code - 2wndrhs/aoc-2024-typescript-template
README
# Advent of Code 2024 TypesScript Template
This is a TypeScript template for [advent of code 2024](https://adventofcode.com/2024).
The template was built with
- [pnpm](https://pnpm.io/)
- [typescript](https://www.typescriptlang.org/)
- [vitest](https://vitest.dev/)
## Usage
```shell
$ git clone https://github.com/2wndrhs/aoc-2024-typescript-template.git
$ cd aoc-2024-typescript-template
# install dependencies
$ pnpm install
# run tests for day01
$ pnpm test day01
# run the day01
$ pnpm start day01
```
## Generate
You can generate all necessary files for AoC solution with a simple command:
```shell
$ pnpm gen day01
```
The command creates the following files
```shell
* creating src/day01/resources/input.txt
* creating src/day01/main.ts
* creating src/day01/part2.ts
* creating src/day01/part1.ts
* creating src/day01/__tests__/day01.test.ts
```
For download the inputs from web, you need to set the AOC_SESSION environment variable in `.env` file.
You can get the session value from AoC website cookie. (`Developer Tools` > `Application` > `Cookies`)
The env file should look like below.
```
AOC_SESSION={YOUR_AOC_SESSION_VALUE}
```