README
¶
Welcome to HTML Analyzer (Backend) Project!
A Backend-Only HTML Analyzer Project to analyze your web page, fully written using Go Language. This application is able to analyze the following attributes :
- HTML Version of the page
- Page title
- Heading Level counts (From h1 to h6!)
- Number of Internal and External Links
- Number of Inaccessible Links (yep, you read that right!)
- Whether your page contains login form or not
How to run
A provided makefile make everything easy! Simply run the following commands to do things :
- Clone the project and change current directory to the project folder
- To build the project, just run
make build - When you're done buildidng, run
make runto run the application. Remember, the default port used in this application is 8087. Watch out for any other applications running on the same port. - To run the pre-written tests, run
make test - Last but not least, to remove the binary, run
make clean
How to use
After you run the application, you can use it by hit the endpoint /analyzehtml using GET method, and give your URL as the request parameter.
Example : localhost:8087/analyzehtml?url=https://www.amazon.com
You have to use complete URL to use this application (http:// or https:// along with www.)
The response then will be returned in JSON format.
How to contribute
As they say, no project is perfect. This project also need many improvements. Therefore, if you found anything you can improve, please don't hesitate to create an issue and make a pull request. I will review it as soon as possible! :)
Directories