Skip to content

Latest commit

 

History

History
115 lines (73 loc) · 3.13 KB

README.md

File metadata and controls

115 lines (73 loc) · 3.13 KB
Raw

Z1 Advent of code ⭐️

This is an starting kit for Advent of code (AoC). It's created to provide you with the code structure and functionality so you can focus on designing your solutions for the puzzles.

The following features are included:

  • Providing a javascript template for daily solutions
  • Allowing you to work on your solutions with dev mode
  • Fetching your input automatically
  • Submitting your solution from the terminal
  • Creating and updating automatically a nice overwiew README with your progress

How to start

Install dependencies:

pnpm install

Add .env file with variables:

AOC_SESSION_KEY=
YEAR=

To get your AOC_SESSION_KEY, go to Advent of code, open your inspector console and get session cookie from the Application tab.

Using AOC_SESSION_KEY is optional. You can leave this empty and work "manually", by simply copying and pasting input and solutions between your IDE and the AoC web.

But you will loose access to some features like fetching input automatically, sending solutions, updating readme automatically with your progress.

(Optional) Update your README:

pnpm update:readme

Init a fresh copy of a README that will overwrite this one and reflect your progress completing the puzzles. Don't worry, if you don't want to do that just yet, README will be automatically generated after you submit your first answer successfully.

README appearance

Generate files for your first puzzle

pnpm start <dayNum>

Example

pnpm start 1

The pnpm start <day> command creates a folder at the /puzzles directory with a starting template to solving your puzzle.

The /puzzles directory will be your main working directory, containing all your solutions.

You can customize this template to your liking by editing files at /templates/js directory.

Work on your puzzle

You can run dev mode in one terminal along with tests in other to work on your solution:

pnpm dev <dayNum>

Example

pnpm dev 1

Run test on changed files:

pnpm test

work on your puzzle, screenshot of terminal

Submit your solution

Once your ready, you can send your solution to Advent of code from the terminal:

pnpm submit <dayNum>

Example

pnpm submit 1

If your solution is correct, you will see a message in the terminal and this README will be updated automatically to show your progress ✨.

Join the leaderboard

If you're a Z1 employee, you can join Z1's private leaderboard:

3197226-79081dfb

Also register to the AoC internal event for a chance to redeem the stars you won for fantastic Z1 swag and become the ⭐️⭐️ Z1 Coder of the year ⭐️⭐️.

Join channel #z1-initiative-advent-of-code

Acknowledgements

This template is heavily inspired on a awesome AOC runner from @caderek. Check it out here.