Shihab/AmpTechnicalChallengeAppv1.0.0

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

This is a CLI application for the amp-technical challenge. Which, when provided a URL for a remote file, retrieves the file and processes it according to the functionality described in the challenge. => Find out the ids corresponding to the n largest numbers.--

Here's the list of function of this CLI:

• Take input for the AWS S3 publicly accessible URL for data source
• Take input How many ids/records corresponding to the n largest numbers you want to display ?
• Find out the ids corresponding to the n largest numbers.

About docker container --
The application and the other required services are configured as docker containers, and these will use a preconfigured docker network named amp-technical-challenge. This network is not connected to the Internet. The endpoints of the server are exposed to the host machine.

(back to top)

Built With

Here listed frameworks/libraries used to bootstrap this project.

• Visual Studio IDE 2022
• ASP dot core 3.1
• xUnit Test
• AWS S3 Storage
• Docker Container

(back to top)

Getting Started

How we can run the Application >>>

Prerequisites

Things you need to use the software and how to install them.

• Visual Studio / Visual Studio Code [But not mendatory.]
• Docker Container [Without docker container we can run and test the app]

Installation

Below is an example of how you can installing and setting up your app.

1. First, download and extract the app in any directory in your local PC.

2. Without visual studio we can run the CLI through prebuild AmpTechnicalChallengeApp.exe >>> location of prebuild CLI => Go to your project location where you have extract the project and go to this folder location and find out AmpTechnicalChallengeApp.exe then just double clik the AmpTechnicalChallengeApp.exe\AmpTechnicalChallengeApp\AmpTechnicalChallengeApp\bin\Debug\netcoreapp3.1\AmpTechnicalChallengeApp.exe

3. When CLI open it will ask a

   • Please input a AWS S3 publicly accessible URL for data source :. You can input this sample data source for testing the app. https://amp-technical-challenge-shihab.s3.ap-northeast-1.amazonaws.com/sw-engineer-challenge.txt. Or if you have your own AWS S3 publicly accessible URL for data source. You can use that one. But please make sure that .text file contains data as like >>> <unique record identifier><white_space><numeric value>
   • Next: It will ask >>> How many ids/records corresponding to the n largest numbers you want to display ? :. Then please input your desired integer number. How many records you want see.

4. [Optional] If you want to give public access to your AWS S3 bucket then you can follow this procedures from this URL >>> https://aws.amazon.com/premiumsupport/knowledge-center/read-access-objects-s3-bucket/

(back to top)

Usage

(back to top)

Roadmap

• Improve the algorithm to read and process for extremely large files from AWS cloud storage

(back to top)

Contributing

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Shihab Uddin - shihab.se.info@gmail.com

(back to top)

Acknowledgments