akita

README

akita

Akita is a command line tool to crawl a website looking for broken links.

The tool is named after the Akita dog breed which are very protective of their home & owners.

.

Installation

The akita tool is written using Go. So the first step is to download and install Go and set your development environment.

Akita uses packages outside of the standard library, each of those packages need to be imported on the go environment before compiling the tool:

go get github.com/fatih/color
go get gopkg.in/fatih/set.v0
go get github.com/jackdanger/collectlinks

Download the code and put it on a folder named 'akita' inside the $GOPATH/src folder of your Go environment.

Compile the tool:

go build akita.go

Base Host Configuration

The server application follows the recomendation of the twelve-factor app regarding configuration. Store the configuration in environment variables. To set the variables use the "export" command. For instance:

sudo nano ~/.bash_profile

Add the following line to the end of the file

export AK_HOST="www.yoursite.com"

Save the file and return to the command line. Run the new configuration

source ~/.bash_profile

The variable you just set is used by the tool to determine URLs that are outside the bounds of the target website.

Run the tool

To run the tool call it as:

./akita -website="http://www.yoursite.com"

Documentation

Overview

The MIT License (MIT)

Copyright (c) 2017 Greivin López

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.