extern/web-check
1
0
Fork 0
mirror of https://github.com/Lissy93/web-check.git synced 2025-03-12 05:59:34 +01:00
Code Issues Packages Projects Releases Wiki Activity

Updates readme, with deployment instructions

Browse Source
This commit is contained in:
Alicia Sykes 2023-06-26 17:24:33 +01:00
parent 8d9e29d600
commit e9a8dd0d9d
1 changed files with 69 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

79
README.md
View File

@ -1,9 +1,12 @@
<h1 align="center">Web-Check</h1>
<p align="center">
<b><i>Comprehensive, on-demand open source intelligence for any website</i></b>
<br />
<b>🌐 <a href="https://web-check.as93.net/">web-check.as93.net</a></b>
<img src="https://i.ibb.co/q1gZN2p/web-check-logo.png" width="96" /><br />
<b><i>Comprehensive, on-demand open source intelligence for any website</i></b>
<br />
<b>🌐 <a href="https://web-check.as93.net/">web-check.as93.net</a></b><br />
</p>
---
@ -13,26 +16,82 @@
_Get info on a websites SSL certs, domain, headers, cookies, DNS records, technologies used, performance, hostnames, crawl rules, server info and more_
#### Screenshot
<a href="https://web-check.as93.net/">
<img width="700" src="https://i.ibb.co/9ZcMVbP/web-check-screenshot3.png" />
</a>
[![Screenshot](https://i.ibb.co/9ZcMVbP/web-check-screenshot3.png)](https://web-check.as93.net/)
#### Live Demo
A hosted version can be accessed at: **[web-check.as93.net](https://web-check.as93.net)**
#### Mirror
The source for this repo is mirrored to CodeBerg, available at: **[codeberg.org/alicia/web-check](https://codeberg.org/alicia/web-check)**
#### Motivation
Often when I'm looking into a website, there's several things I always check first.
None of this is hard, and can usually be done with a series of curl commands, or using a combination of online tools.
But it's so much easier to have everything presented clearly and visible in one place.
#### Features
- Server Location
- SSL Info
- Headers
- Associated hostnames
- Domain Whois
- DNS records
- Cookies
- Server info
- Crawl rules
- Performance metrics
- Screenshot
- Tech stack
- Site response times
_Note that not all checks will work for all sites. Sometimes it's not possible to determine some information, and there are limitations imposed by Netlify for the lambda functions._
#### Architecture
It's just a very simple web app (React + TypeScript), with results calculated using a series of Lambda functions. Everything is deployed on Netlify. Most things are done with the native http interface, but there's a few instances where this wasn't possible alone, so is combined with some external APIs, like Shodan for hostnames, IP Info for geolocation, and Google Cloud for performance metrics.
---
## Building
---
### Developing
## Deploying
You'll need [Node.js](https://nodejs.org/en) (V 18.16.1 or later) installed.
1. Clone the repo, `git clone git@github.com:Lissy93/web-check.git`
2. Cd into it, `cd web-check`
3. Install dependencies: `npm i`
4. Populate environmental variables, in the `.env`
5. Start the dev server, with `npx netlify-cli dev`
### Deploying
[![Deploy to Netlify](https://img.shields.io/badge/Deploy-Netlify-%2330c8c9?style=for-the-badge&logo=netlify&labelColor=1e0e41 'Deploy Web-Check to Netlify, via 1-Click Script')](https://app.netlify.com/start/deploy?repository=https://github.com/lissy93/web-check)
---
## Contributing
## Community
### Contributing
Contributions of any kind are very welcome, and would be much appreciated.
For Code of Conduct, see [Contributor Convent](https://www.contributor-covenant.org/version/2/1/code_of_conduct/).
To get started, fork the repo, make your changes, add, commit and push the code, then come back here to open a pull request. If you're new to GitHub or open source, [this guide](https://www.freecodecamp.org/news/how-to-make-your-first-pull-request-on-github-3#let-s-make-our-first-pull-request-) or the [git docs](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) may help you get started, but feel free to reach out if you need any support.
[![Submit a PR](https://img.shields.io/badge/Submit_a_PR-GitHub-%23060606?style=for-the-badge&logo=github&logoColor=fff)](https://github.com/Lissy93/web-check/compare)
### Found a Bug
If you've found something that doesn't work as it should, or would like to suggest a new feature, then go ahead and raise a ticket on GitHub.
For bugs, please outline the steps needed to reproduce, and include relevant info like system info and resulting logs.
[![Raise an Issue](https://img.shields.io/badge/Raise_an_Issue-GitHub-%23060606?style=for-the-badge&logo=github&logoColor=fff)](https://github.com/Lissy93/web-check/issues/new/choose)
### Supporting
[![Sponsor Lissy93 on GitHub](https://img.shields.io/badge/Sponsor_on_GitHub-Lissy93-%23ff4dda?style=for-the-badge&logo=githubsponsors&logoColor=ff4dda)](https://github.com/sponsors/Lissy93)
---