sashkan / advent-of-code-node-starter

This repository provides an optimal starting point for Advent of Code enthusiasts who prefer using Node.js

🎅 advent-of-code-node-starter ⭐

This repository provides an optimal starting point for Advent of Code enthusiasts who prefer using Node.js

✔️ Before start

• Make sure you got node.js installed on your machine, if you don't, go to the official website

$ node -v

🚀 Launch project

• Clone the repository

$ # With SSH
$ git clone [email protected]:JeanM38/advent-of-code-node-starter.git my_advent_of_code

$ # With HTTPS
$ git clone https://github.com/JeanM38/advent-of-code-node-starter.git my_advent_of_code

• Get into your local repository

$ cd my_advent_of_code

• Link bin commands to allow them

$ npm link

• Install all dependencies

$ npm install

🛠️ Generate a new day

Each day, a new algorithm to create, a template is here to help you, just run this command to create a new folder and retrieve advent of code data

$ npm exec new-day {YEAR} {DAY}

At this point, you got three files in a new folder (for example 2023/1) :

challenge.js

Insert your algorithm into this method, don't hesitate to create other methods and class properties to resolve the problem and keep your code clean

input.txt

Each challenge comes with its input, the Challenge class of the challenge.js file will read it input inside of this file.

README.md

You can retrieve the challenge instructions here

📜 This repository respects automation guidelines

This repo/tool does follow the automation guidelines on the /r/adventofcode community wiki

⚠️ Be a good fellow

Please don't push your solutions on GitHub, think about your developers friends