https://github.com/ldgit/code-challenge-im

https://github.com/ldgit/code-challenge-im

Last synced: 5 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/ldgit/code-challenge-im
• Owner: ldgit
• License: gpl-3.0
• Created: 2024-10-15T19:50:17.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-17T09:07:12.000Z (over 1 year ago)
• Last Synced: 2025-03-31T08:15:55.070Z (12 months ago)
• Language: JavaScript
• Size: 120 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Code challenge

A code challenge made for a job application.

## Requirements

- Node.js v20+

- npm v10+

## Usage instructions

### Installation

1. Clone this repository and `cd` into it.

2. Run `npm ci` to install npm packages.

3. Run the script.

### Running the script

This script uses `IM_SECRET` env variable as a secret key for hashing, and will fail without it.

You can ensure it is set for your current session by running `export IM_SECRET=your_secret_key` **before** running the script.

There are several ways to run the script:

- `node ./index.js ./path/to/file.txt` - parse a txt file

- `node ./index.js` - if no file path is provided the script will parse the input from `stdin` line by line

  - `echo "some text with [www.example.com] url" | node ./index.js` - pipe output from another command

- `node ./index.js -h` or `./index.js --help` for complete instructions

Additional notes:

- When parsing a txt file, the script will end on its own once the requests to *all* urls (*and* all the queued retries) have been made. In case of a retry this means that it may take more than 60 seconds to script to end.

- When parsing from `stdin`, press `control + D` or `control + C` to end the script.