Web Check API

A light-weight Go API for discovering website data
Web Check - Gives you Xray Vision for any Website

Note

This is a very early work in progress, and is not yet feature complete or production ready. Stay tuned!

---

Usage

Developing

Getting Started

You will need git and go installed. Then clone the repo and download dependencies.

git clone git@github.com:xray-web/web-check-api.git
cd web-check-api
go mod download

Start Server

make run

Run Tests

make test

Deploying

Option 1: From Source

Follow the setup instructions above. Then build the binaries. Then execute the output executable directly (e.g. ./bin/app)

make build

Option 2: From Docker

docker run -p 8080:8080 lissy93/web-check-api

Option 3: Download Executable

From the releases tab, download the compiled binary for your system, and execute it.

---

License

Web Check is licensed under MIT © Alicia Sykes 2024.
^{For information, see TLDR Legal > MIT}

Expand License

The MIT License (MIT)
Copyright (c) Alicia Sykes <alicia@omg.com> 

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, sub-license, 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 install 
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 MERCHANT ABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NON INFRINGEMENT. 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.

© Alicia Sykes 2024
Licensed under MIT

^{Thanks for visiting :)}