Coding Challenge

Features

1. Three tier architecture code structure.
2. Unit and Integration testing.
3. ESLint using Airbnb style guide.
4. Docker deployment with docker compose file.
5. Code style uses some of es2016+ features.
6. Configuration files can be separated for each Deployment environments.
7. Web application requests is served and proxied through NGINX.
8. Compression using gzip.
9. Removed some security vulnerabilities.
10. Data store is automatically seeded (For testing purposes)

Deployment

Server Requirements:

To be able to run and test the application you need to install the following:

1. Docker
2. Docker Compose
3. Node.js 12 (Optional for running the tests)

To run the application :

1. Download and build the images

$ docker-compose build

2. Run the containers

$ docker-compose up 

3. To access the web interface: Go to "http://localhost"

For testing for purposes redis database is preloaded with 50,000 emails.

Sample fake email addresses in data store:

1. Mervin.Graham@hotmail.com
2. Kathryne.Raynor42@hotmail.com
3. Willa_Jast48@hotmail.com

Testing

To execute Unit and Integration test:

$ npm run test

Testing requires Redis to be accessible. To be able to successfully run it, you need to expose redis service TCP port from "6379" to "6379:6379" in docker-compose.yml file.

Inspirations:

1. Docker deployment: https://github.com/DanWahlin/CodeWithDanDockerServices