Skip to content

Commit

Permalink
Merge branch 'main' into feat/new-endpoints
Browse files Browse the repository at this point in the history
  • Loading branch information
Lissy93 authored Jun 9, 2024
2 parents f8aa1fa + a856eff commit 4b93794
Show file tree
Hide file tree
Showing 24 changed files with 662 additions and 27 deletions.
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* @Lissy93
135 changes: 135 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,135 @@
# Contributor Covenant Code of Conduct

> This is our code of conduct, based upon the [Contributor Covenant](https://www.contributor-covenant.org/).
> It outlines a set of core values and norms that are essential in a just and equitable software commons.
> You must abide by these if you wish to contribute to this project.
> For contributing guidelines - see [`CONTRIBUTING.md`](https://github.com/Lissy93/git-into-open-source/blob/main/.github/CONTRIBUTING.md)
>
> **TLDR; Don't be a d!ck**
## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, religion, or sexual identity
and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the
overall community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or
advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
alicia <alicia@omg.lol>.
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series
of actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or
permanent ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within
the community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.

Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.
Empty file added .github/CONTRIBUTING.md
Empty file.
1 change: 1 addition & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
github: [lissy93, kynrai]
122 changes: 122 additions & 0 deletions .github/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,122 @@
<h1 align="center">Web Check API</h1>
<p align="center">
<a href="https://github.com/lissy93/web-check">
<img width="72" src="./web-check.png?raw=true" />
<br />
</a>
<i>A light-weight Go API for discovering website data</i><br />
<b><a href="https://web-check.xyz">Web Check</a> - <i>Gives you Xray Vision for any Website</i></b>
</p>

> [!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](https://git-scm.com/) and [go](https://go.dev/) 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](https://github.com/Lissy93/web-check)** is licensed under [MIT](https://github.com/xray-web/web-check-api/blob/HEAD/LICENSE) © [Alicia Sykes](https://aliciasykes.com) 2024._<br>
> <sup align="right">For information, see <a href="https://tldrlegal.com/license/mit-license">TLDR Legal > MIT</a></sup>
<details>
<summary>Expand License</summary>

```
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.
```

</details>


<!-- License + Copyright -->
<p align="center">
<i>© <a href="https://aliciasykes.com">Alicia Sykes</a> 2024</i><br>
<i>Licensed under <a href="https://gist.github.com/Lissy93/143d2ee01ccc5c052a17">MIT</a></i><br>
<a href="https://github.com/lissy93"><img src="https://i.ibb.co/4KtpYxb/octocat-clean-mini.png" /></a><br>
<sup>Thanks for visiting :)</sup>
</p>

<!-- Dinosaurs are Awesome -->
<!--
. - ~ ~ ~ - .
.. _ .-~ ~-.
//| \ `..~ `.
|| | } } / \ \
(\ \\ \~^..' | } \
\`.-~ o / } | / \
(__ | / | / `.
`- - ~ ~ -._| /_ - ~ ~ ^| /- _ `.
| / | / ~-. ~- _
|_____| |_____| ~ - . _ _~_-_
-->


Empty file added .github/SECURITY.txt
Empty file.
43 changes: 43 additions & 0 deletions .github/SUPPORT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Support

First and foremost, thank you for using Web Check!
We're committed to providing a welcoming environment and ensuring all users can
utilize our work effectively. This document outlines the various avenues available
if you need help.

## 📖 Documentation

Before reaching out with your query, we recommend:

1. Reviewing the [`README`](/.github/README.md) for an overview of the project.
2. Checking out our [`CONTRIBUTING`](/.github/CONTRIBUTING.md) guidelines if you're looking to submit changes.
3. Familiarizing yourself with our [`CODE_OF_CONDUCT`](/.github/CODE_OF_CONDUCT.md) to understand community behavior expectations.

## 🐛 Bug Reports & Feature Requests

If you've identified a bug or want to request a new feature:

1. Search the [Issues](https://github.com/xray-web/web-check-api/issues) to see if it's already been reported.
2. If not, open a new issue! Please provide as much information as possible to help us understand and address the issue quickly.

## 💬 Discussion & Questions

For general discussion, questions about the project, or if you're unsure where to start:

1. Join our community chat (if applicable).
2. Start a discussion on the project's [Discussion tab](https://github.com/xray-web/web-check-api/discussions).

## 🚀 Get Involved!

If you're excited about our project, there are many ways to get involved:

1. Star the repository – it helps boost visibility and shows your support!
2. Check out "good first issues" or "help wanted" tags in the [Issues section](https://github.com/xray-web/web-check-api/issues) to get started with contributions.
3. Spread the word in your network and community.

## 📧 Contact

If you have specific concerns or need to reach out directly, contact the core maintainers:

- **Maintainers** - [Email](mailto:maintainers@web-check.xyz)

Binary file added .github/web-check.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
50 changes: 50 additions & 0 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
name: 🚀 Deploy to Fly
on:
workflow_dispatch:
push:
branches:
- main
jobs:
deploy:
name: Deploy app
runs-on: ubuntu-latest
concurrency: deploy-group
permissions:
deployments: write
steps:
- name: Checkout 🛎️
uses: actions/checkout@v4

- name: Setup Fly 🧰
uses: superfly/flyctl-actions/setup-flyctl@master

- name: Create GitHub deployment 🐙
uses: chrnorm/deployment-action@v2
id: deployment
with:
token: ${{ secrets.BOT_TOKEN || secrets.GITHUB_TOKEN }}
environment-url: http://api.web-check.xyz
environment: production

- name: Deploy to Fly.io 🛩️
run: flyctl deploy --remote-only
env:
FLY_API_TOKEN: ${{ secrets.FLY_TOKEN }}

- name: Update deployment status (success) ✅
if: success()
uses: chrnorm/deployment-status@v2
with:
token: ${{ secrets.BOT_TOKEN || secrets.GITHUB_TOKEN }}
environment-url: ${{ steps.deployment.outputs.environment_url }}
deployment-id: ${{ steps.deployment.outputs.deployment_id }}
state: 'success'

- name: Update deployment status (failure) ❌
if: failure()
uses: chrnorm/deployment-status@v2
with:
token: ${{ secrets.BOT_TOKEN || secrets.GITHUB_TOKEN }}
environment-url: ${{ steps.deployment.outputs.environment_url }}
deployment-id: ${{ steps.deployment.outputs.deployment_id }}
state: 'failure'
Loading

0 comments on commit 4b93794

Please sign in to comment.