Project Lintol - Challenge 1

A open source submission to the Lintol Challenge to identify Personally Identifiable Information within CSV files.

Getting Started

These instructions will enable you to setup and run the project on your local machine for development and testing purposes.

Prerequisites

What things you need to install the software and how to install them

• Docker
• Node

Setting up local development

The following steps will checkout the repository, install the dependencies needed for the React frontend and run the service on http://localhost.

$ git clone https://github.com/robertwpaul/lintol-challenge-1
$ cd lintol-challenge-1
$ docker-compose up

And to tear down the local development stack, simply run:

$ docker-compose down

Output

The output will be written to data/output.json; running this script with docker-compose up or node index.js will overide the output in the /data folder.

Available Processors

The following is a list of the available processors:

• Email Address
• MAC Address
• IP Address
• National Insurance
• Phone Number
• Vehicle Registration

Adding a processor

Adding a new processor couldn't be easier.

• Create a new directory under /src/processors with your processor name
• Add processor implementation within the new created directory
• Add the processor as an export within /src/processors/index.js
• Run your processor using docker-compose up

Running Tests

Jest is used by Facebook to test all JavaScript code including React applications. One of Jest's philosophies is to provide an integrated "zero-configuration" experience. We observed that when engineers are provided with ready-to-use tools, they end up writing more tests, which in turn results in more stable and healthy code bases.

docker-compose run test

Code style

This codebase is formatted with Prettier. Prettier is an opinionated code formatter. It enforces a consistent style by parsing your code and re-printing it with its own rules that take the maximum line length into account, wrapping code when necessary.

To ensure code consistency within this repository you should run the following command before committing code:

docker-compose run task npm run format

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue

Contributors

A list of contributors who participated in this project.

Kyle Harrison 💻	Robert Paul 💻

License

Licensed under the Unlicense.

---