Skip to content

Commit ff31e06

Browse files
kynraikynrai
committed
Merge remote-tracking branch 'origin/main' into rf/standardise_url_param
2 parents 8f649a2 + a856eff commit ff31e06

20 files changed

+657
-21
lines changed

‎.github/CODEOWNERS

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* @Lissy93

‎.github/CODE_OF_CONDUCT.md

+135
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,135 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
> This is our code of conduct, based upon the [Contributor Covenant](https://www.contributor-covenant.org/).
4+
> It outlines a set of core values and norms that are essential in a just and equitable software commons.
5+
> You must abide by these if you wish to contribute to this project.
6+
> For contributing guidelines - see [`CONTRIBUTING.md`](https://github.com/Lissy93/git-into-open-source/blob/main/.github/CONTRIBUTING.md)
7+
>
8+
> **TLDR; Don't be a d!ck**
9+
10+
## Our Pledge
11+
12+
We as members, contributors, and leaders pledge to make participation in our
13+
community a harassment-free experience for everyone, regardless of age, body
14+
size, visible or invisible disability, ethnicity, sex characteristics, gender
15+
identity and expression, level of experience, education, socio-economic status,
16+
nationality, personal appearance, race, religion, or sexual identity
17+
and orientation.
18+
19+
We pledge to act and interact in ways that contribute to an open, welcoming,
20+
diverse, inclusive, and healthy community.
21+
22+
## Our Standards
23+
24+
Examples of behavior that contributes to a positive environment for our
25+
community include:
26+
27+
* Demonstrating empathy and kindness toward other people
28+
* Being respectful of differing opinions, viewpoints, and experiences
29+
* Giving and gracefully accepting constructive feedback
30+
* Accepting responsibility and apologizing to those affected by our mistakes,
31+
and learning from the experience
32+
* Focusing on what is best not just for us as individuals, but for the
33+
overall community
34+
35+
Examples of unacceptable behavior include:
36+
37+
* The use of sexualized language or imagery, and sexual attention or
38+
advances of any kind
39+
* Trolling, insulting or derogatory comments, and personal or political attacks
40+
* Public or private harassment
41+
* Publishing others' private information, such as a physical or email
42+
address, without their explicit permission
43+
* Other conduct which could reasonably be considered inappropriate in a
44+
professional setting
45+
46+
## Enforcement Responsibilities
47+
48+
Community leaders are responsible for clarifying and enforcing our standards of
49+
acceptable behavior and will take appropriate and fair corrective action in
50+
response to any behavior that they deem inappropriate, threatening, offensive,
51+
or harmful.
52+
53+
Community leaders have the right and responsibility to remove, edit, or reject
54+
comments, commits, code, wiki edits, issues, and other contributions that are
55+
not aligned to this Code of Conduct, and will communicate reasons for moderation
56+
decisions when appropriate.
57+
58+
## Scope
59+
60+
This Code of Conduct applies within all community spaces, and also applies when
61+
an individual is officially representing the community in public spaces.
62+
Examples of representing our community include using an official e-mail address,
63+
posting via an official social media account, or acting as an appointed
64+
representative at an online or offline event.
65+
66+
## Enforcement
67+
68+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
69+
reported to the community leaders responsible for enforcement at
70+
alicia <alicia@omg.lol>.
71+
All complaints will be reviewed and investigated promptly and fairly.
72+
73+
All community leaders are obligated to respect the privacy and security of the
74+
reporter of any incident.
75+
76+
## Enforcement Guidelines
77+
78+
Community leaders will follow these Community Impact Guidelines in determining
79+
the consequences for any action they deem in violation of this Code of Conduct:
80+
81+
### 1. Correction
82+
83+
**Community Impact**: Use of inappropriate language or other behavior deemed
84+
unprofessional or unwelcome in the community.
85+
86+
**Consequence**: A private, written warning from community leaders, providing
87+
clarity around the nature of the violation and an explanation of why the
88+
behavior was inappropriate. A public apology may be requested.
89+
90+
### 2. Warning
91+
92+
**Community Impact**: A violation through a single incident or series
93+
of actions.
94+
95+
**Consequence**: A warning with consequences for continued behavior. No
96+
interaction with the people involved, including unsolicited interaction with
97+
those enforcing the Code of Conduct, for a specified period of time. This
98+
includes avoiding interactions in community spaces as well as external channels
99+
like social media. Violating these terms may lead to a temporary or
100+
permanent ban.
101+
102+
### 3. Temporary Ban
103+
104+
**Community Impact**: A serious violation of community standards, including
105+
sustained inappropriate behavior.
106+
107+
**Consequence**: A temporary ban from any sort of interaction or public
108+
communication with the community for a specified period of time. No public or
109+
private interaction with the people involved, including unsolicited interaction
110+
with those enforcing the Code of Conduct, is allowed during this period.
111+
Violating these terms may lead to a permanent ban.
112+
113+
### 4. Permanent Ban
114+
115+
**Community Impact**: Demonstrating a pattern of violation of community
116+
standards, including sustained inappropriate behavior, harassment of an
117+
individual, or aggression toward or disparagement of classes of individuals.
118+
119+
**Consequence**: A permanent ban from any sort of public interaction within
120+
the community.
121+
122+
## Attribution
123+
124+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
125+
version 2.0, available at
126+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
127+
128+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
129+
enforcement ladder](https://github.com/mozilla/diversity).
130+
131+
[homepage]: https://www.contributor-covenant.org
132+
133+
For answers to common questions about this code of conduct, see the FAQ at
134+
https://www.contributor-covenant.org/faq. Translations are available at
135+
https://www.contributor-covenant.org/translations.

‎.github/CONTRIBUTING.md

Whitespace-only changes.

‎.github/FUNDING.yml

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
github: [lissy93, kynrai]

‎.github/README.md

+122
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,122 @@
1+
<h1 align="center">Web Check API</h1>
2+
<p align="center">
3+
<a href="https://github.com/lissy93/web-check">
4+
<img width="72" src="./web-check.png?raw=true" />
5+
<br />
6+
</a>
7+
<i>A light-weight Go API for discovering website data</i><br />
8+
<b><a href="https://web-check.xyz">Web Check</a> - <i>Gives you Xray Vision for any Website</i></b>
9+
</p>
10+
11+
> [!NOTE]
12+
> This is a very early work in progress, and is not yet feature complete or production ready.
13+
> Stay tuned!
14+
15+
---
16+
17+
## Usage
18+
19+
### Developing
20+
21+
#### Getting Started
22+
23+
You will need [git](https://git-scm.com/) and [go](https://go.dev/) installed.
24+
Then clone the repo and download dependencies.
25+
26+
```
27+
git clone git@github.com:xray-web/web-check-api.git
28+
cd web-check-api
29+
go mod download
30+
```
31+
32+
#### Start Server
33+
34+
```
35+
make run
36+
```
37+
38+
#### Run Tests
39+
40+
```
41+
make test
42+
```
43+
44+
45+
### Deploying
46+
47+
#### Option 1: From Source
48+
49+
Follow the setup instructions above. Then build the binaries.
50+
Then execute the output executable directly (e.g. `./bin/app`)
51+
52+
```
53+
make build
54+
```
55+
56+
#### Option 2: From Docker
57+
58+
```
59+
docker run -p 8080:8080 lissy93/web-check-api
60+
```
61+
62+
#### Option 3: Download Executable
63+
From the releases tab, download the compiled binary for your system, and execute it.
64+
65+
---
66+
67+
## License
68+
69+
> _**[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>
70+
> <sup align="right">For information, see <a href="https://tldrlegal.com/license/mit-license">TLDR Legal > MIT</a></sup>
71+
72+
<details>
73+
<summary>Expand License</summary>
74+
75+
```
76+
The MIT License (MIT)
77+
Copyright (c) Alicia Sykes <alicia@omg.com>
78+
79+
Permission is hereby granted, free of charge, to any person obtaining a copy
80+
of this software and associated documentation files (the "Software"), to deal
81+
in the Software without restriction, including without limitation the rights
82+
to use, copy, modify, merge, publish, distribute, sub-license, and/or sell
83+
copies of the Software, and to permit persons to whom the Software is furnished
84+
to do so, subject to the following conditions:
85+
86+
The above copyright notice and this permission notice shall be included install
87+
copies or substantial portions of the Software.
88+
89+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
90+
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANT ABILITY, FITNESS FOR A
91+
PARTICULAR PURPOSE AND NON INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
92+
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
93+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
94+
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
95+
```
96+
97+
</details>
98+
99+
100+
<!-- License + Copyright -->
101+
<p align="center">
102+
<i>© <a href="https://aliciasykes.com">Alicia Sykes</a> 2024</i><br>
103+
<i>Licensed under <a href="https://gist.github.com/Lissy93/143d2ee01ccc5c052a17">MIT</a></i><br>
104+
<a href="https://github.com/lissy93"><img src="https://i.ibb.co/4KtpYxb/octocat-clean-mini.png" /></a><br>
105+
<sup>Thanks for visiting :)</sup>
106+
</p>
107+
108+
<!-- Dinosaurs are Awesome -->
109+
<!--
110+
. - ~ ~ ~ - .
111+
.. _ .-~ ~-.
112+
//| \ `..~ `.
113+
|| | } } / \ \
114+
(\ \\ \~^..' | } \
115+
\`.-~ o / } | / \
116+
(__ | / | / `.
117+
`- - ~ ~ -._| /_ - ~ ~ ^| /- _ `.
118+
| / | / ~-. ~- _
119+
|_____| |_____| ~ - . _ _~_-_
120+
-->
121+
122+

‎.github/SECURITY.txt

Whitespace-only changes.

‎.github/SUPPORT.md

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Support
2+
3+
First and foremost, thank you for using Web Check!
4+
We're committed to providing a welcoming environment and ensuring all users can
5+
utilize our work effectively. This document outlines the various avenues available
6+
if you need help.
7+
8+
## 📖 Documentation
9+
10+
Before reaching out with your query, we recommend:
11+
12+
1. Reviewing the [`README`](/.github/README.md) for an overview of the project.
13+
2. Checking out our [`CONTRIBUTING`](/.github/CONTRIBUTING.md) guidelines if you're looking to submit changes.
14+
3. Familiarizing yourself with our [`CODE_OF_CONDUCT`](/.github/CODE_OF_CONDUCT.md) to understand community behavior expectations.
15+
16+
## 🐛 Bug Reports & Feature Requests
17+
18+
If you've identified a bug or want to request a new feature:
19+
20+
1. Search the [Issues](https://github.com/xray-web/web-check-api/issues) to see if it's already been reported.
21+
2. If not, open a new issue! Please provide as much information as possible to help us understand and address the issue quickly.
22+
23+
## 💬 Discussion & Questions
24+
25+
For general discussion, questions about the project, or if you're unsure where to start:
26+
27+
1. Join our community chat (if applicable).
28+
2. Start a discussion on the project's [Discussion tab](https://github.com/xray-web/web-check-api/discussions).
29+
30+
## 🚀 Get Involved!
31+
32+
If you're excited about our project, there are many ways to get involved:
33+
34+
1. Star the repository – it helps boost visibility and shows your support!
35+
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.
36+
3. Spread the word in your network and community.
37+
38+
## 📧 Contact
39+
40+
If you have specific concerns or need to reach out directly, contact the core maintainers:
41+
42+
- **Maintainers** - [Email](mailto:maintainers@web-check.xyz)
43+

‎.github/web-check.png

3.21 KB
Loading

‎.github/workflows/deploy.yml

+50
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
name: 🚀 Deploy to Fly
2+
on:
3+
workflow_dispatch:
4+
push:
5+
branches:
6+
- main
7+
jobs:
8+
deploy:
9+
name: Deploy app
10+
runs-on: ubuntu-latest
11+
concurrency: deploy-group
12+
permissions:
13+
deployments: write
14+
steps:
15+
- name: Checkout 🛎️
16+
uses: actions/checkout@v4
17+
18+
- name: Setup Fly 🧰
19+
uses: superfly/flyctl-actions/setup-flyctl@master
20+
21+
- name: Create GitHub deployment 🐙
22+
uses: chrnorm/deployment-action@v2
23+
id: deployment
24+
with:
25+
token: ${{ secrets.BOT_TOKEN || secrets.GITHUB_TOKEN }}
26+
environment-url: http://api.web-check.xyz
27+
environment: production
28+
29+
- name: Deploy to Fly.io 🛩️
30+
run: flyctl deploy --remote-only
31+
env:
32+
FLY_API_TOKEN: ${{ secrets.FLY_TOKEN }}
33+
34+
- name: Update deployment status (success) ✅
35+
if: success()
36+
uses: chrnorm/deployment-status@v2
37+
with:
38+
token: ${{ secrets.BOT_TOKEN || secrets.GITHUB_TOKEN }}
39+
environment-url: ${{ steps.deployment.outputs.environment_url }}
40+
deployment-id: ${{ steps.deployment.outputs.deployment_id }}
41+
state: 'success'
42+
43+
- name: Update deployment status (failure) ❌
44+
if: failure()
45+
uses: chrnorm/deployment-status@v2
46+
with:
47+
token: ${{ secrets.BOT_TOKEN || secrets.GITHUB_TOKEN }}
48+
environment-url: ${{ steps.deployment.outputs.environment_url }}
49+
deployment-id: ${{ steps.deployment.outputs.deployment_id }}
50+
state: 'failure'

0 commit comments

Comments
 (0)