projects/thebadspace
projects/thebadspace
1
0
Fork 2
Code Issues 11 Pull requests 1 Projects 1 Releases 3 Packages Wiki Activity

CSV Export and API instructions

Browse source 
Added descriptions for usage of the site to the about page, including
the first CSV export as well as instructions for using the API to search
for sites programtically.
This commit is contained in:
Ro 2023-05-07 13:50:12 -07:00
parent 88e78f2c4a
commit 7c5ef7fb0e
No known key found for this signature in database
GPG key ID: 29B551CDBD4D3B50
2 changed files with 54 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
public/assets/css/global/frame.css
View file

@ -68,6 +68,17 @@ a:hover {
border-bottom: 1px solid var(--secondary); border-bottom: 1px solid var(--secondary);
} }
pre {
white-space: pre;
background: var(--secondary);
}
code {
background: var(--secondary);
color: var(--primary);
padding: 3px;
}
sup { sup {
background: var(--black); background: var(--black);
color: var(--white); color: var(--white);

53
templates/front/about.twig
View file

@ -1,4 +1,5 @@
{% extends "base/frame.twig" %} {% extends "base/frame.twig" %}
{% block stylesheets %} {% block stylesheets %}
<link rel="stylesheet" type="text/css" href="/assets/css/front/start.css?=sdfsdf"> <link rel="stylesheet" type="text/css" href="/assets/css/front/start.css?=sdfsdf">
{% endblock %} {% endblock %}
@ -9,20 +10,52 @@
<h2>What is The Bad Space?</h2> <h2>What is The Bad Space?</h2>
<p>The Bad Space project was born from a need to effectively identify instances that house bad actors and are poorly moderated, which puts marginalized communities at risk. <p>The Bad Space project was born from a need to effectively identify instances that house bad actors and are poorly moderated, which puts marginalized communities at risk.
<p> </p>
It is an extension of the <p>
<strong>#fediblock</strong> It is an extension of the
hashtag created by <strong>#fediblock</strong>
<a href="https://www.artistmarciax.com/">Artist Marcia X</a> hashtag created by
with additional support from <a href="https://www.artistmarciax.com/">Artist Marcia X</a>
<a href="https://digital.rooting.garden">Ginger</a> with additional support from
to provide a catalog of instances that seek to cause harm and reduce the quality of experience in the fediverse. <a href="https://digital.rooting.garden">Ginger</a>
</p> to provide a catalog of instances that seek to cause harm and reduce the quality of experience in the fediverse.
</p> </p>
<p> <p>
Technical support provided by Technical support provided by
<a href="https://roiskinda.cool/profile.html">Ro</a>. <a href="https://roiskinda.cool/profile.html">Ro</a>.
</p> </p>
<h2>How do I use it?</h2>
<p>
The Bad Space is meant to be a resource for anyone looking to improve the quality of their online experience by creating a tool that catalogs sources for harassment and abuse. There are several options for how it can be used.
<h3>Search</h3>
To see if a site is listed in the database, use the
<a href="/">search feature</a>
to search for that URL. If it is in the database, information for that instance will be returned and associated instances if applicable.
<h3>CSV Exports</h3>
For a list of the current locations being tracked, click on one of the links below to download a dynamically generated CSV file that can be consumed as a blocklist. More formats will be added over time.
<br/>
<a href="/exports/mastodon">For Mastodon</a>
<h3>API</h3>
The Bad Space has a public api that can be used to search the database programatically and return results in the JSON format. The API can be accsess at<br/>
<code>https://thebad.space/api/v1/search</code>
by posting a JSON object with the following format:
<code>{"url":"search.url"}</code><br/>
Data from API request will be returned in the follow format:<br/>
<pre>
<code>{
"listingCount":1,
"locations":
[
{
"url":"search.url",
"name":"Instance Name",
"description":"instance description",
"link":"bad-space-instance-link"
}
]
}</code>
</pre>
</p>
</section> </section>
{% endblock %} {% endblock %}