###Description### This is a web-software that lists all the present in the local host Perl modules, using AJAX. This is an easy-to-use webpage that has only one mission: to show in a real time Perl modules installed in the system.
But this webpage can trace modules even after their deletion. You can see just deleted modules as "deleted" one more minute after they have been wiped.
The application provides the user with a list of all the modules in the alphabetical order. Each module is presented with its name and its version.
Languages used:
- Perl // as a server-side
- JavaScript // as a client-side
- HTML
- CSS
- JSON // for transmitting data
Frameworks used:
- Bootstrap 3
- jQuery
- File::Find::Rule
- Cpanel::JSON::XS
What I have done
- Developed the two-side web-software: server-side is based on Perl script and the client-side is based on JavaScript.
- Built a dockerfile that builds Ubuntu (last ver.) with fully configured Apache2 and cpanminus on board. To start a new container you just need to call an image (without any parameters and arguments, like: perl myapp.pl etc..). This is a very comfort build that gives me all the power of Apache2 server. Using this biuld you feel like if you work on the full machine with a full server.
###Principles### This program has two parts:
-
"Frontend" which is an .html file (with JS scripts),that receives and parses lists of modules,supplied in JSON format by the backend this Perl script,
-
"Backend" Perl script (actual), that fetches a list of all the installed modules every 5, 10 or 15 seconds (depending on the user's settings), using
@INC, and converts it into JSON format. Then the result is sent to the frontend
Methods
The Perl script uses two modules for implementing the task:
-
"File::Find::Rule" This is a very handy module for searching files on the machine. It provides a very easy API for creating search queries "on fly" and it can work with
@INC, -
Cpanel::JSON::XS" This one gives me a really easy method for converting my data into JSON format.
###The Docker### The software is deitributed with the dockerfile. This meant that you can run the software in the container (aka VM but with lower system requirements and size than a usual VMs).
There are below instructions of how to run:
- First we need to build (and download on fly) the image:
$ sudo docker build -t ag/pckgchecker https://github.com/arseniigorkin/pckgchecker.git. You can replaceag/pckgcheckerwith any name you like for this image. - Run new container:
$ sudo docker run -it --rm -p 9191:80 ag/pckgchecker. You can change the port9191to any you like for outuping the program to your localhost. - Open a browser and type:
http://localhost:9191(please, note: the server is NOT configured for SSL now). - Once you finished working with the app you need to terminate the container. Just type in the terminal (with running container)
CTRL+C.
###Interface###
Once you open a page http://localhost:9191 you may see loading image (until the list will come to the browser in full).
When the page is loaded you see a list of installed modules. and a settings (in the right bottom corner right under the list) for update interval (3 optwions: 5, 10 and 15 secs).
Installed modules are shown with color icon (in the left of the row) and a green "play" icon on the right.
Just added modules will have a label "NEW" next to their names and it will last for 30 seconds from the time of installation.
Just deleted modules will be shown in greyscale colours (b/w icon on the left) and with red cross on the right.
Deleted modules will appear in the list for the next minute.
If you click on "Information" button next to each module, you will see a DEMO information. It has a link to the module's page in the CPAN website and a version number.
Also: if the module is active its icon in this dialogue will be colour, if delete - greyscale.
As I said the build of the Docker includes cpanminus. It means, that you can easily install and uninstall any modules from the host.
To install the module use your open Terminal (which works with the container with the software now) and type: $ sudo cpanm Module::Name. That's it!
To uninstall the module just type in the Terminal (also where the container with this software is active now) and type: $ sudo cpanm --uninstall Module::Name. You will need to confirm the deletion.
To find just installed/uninstalled modules on the screen (in the webpage) just use good old ctrl+f and type there the name of the module you are looking for.
###NB### As I have never worked with any containers like Docker (or any else) and never saw them in the action, so this is my first try (dockerfile). I spent 2 days for understanding the idea and preparing the dockerfile that I supply in this repository.
Also I could create the program using a regular "refresh" method for auto reloading the same page, which could be then fully written on Perl. But it would be too easy and not in the modern way)). Thus I created this mutiful Bootstrap page with AJAX for your comfort. I hope you will enjoy it!
Thank you.
Author: Arsenii Gorkin
