Skip to content

hyphacoop/restructuring-futures

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ReStructuring Futures (RSF)

A public notebook for Restructuring Futures, an experimental collaboration between Hypha Worker Co-op, UKAI Projects and the Laboratory for Artistic Intelligence supported by a grant from the 2020-2021 Digital Strategies Fund at Canada Council for the Arts.

"Restructuring Futures is ostensibly about building infrastructure to support creative and cultural collaboration that is resilient to volatile conditions." More on the latest phase of the project here.

The prototype from Phase 1 lives here.

Running the app locally

If you want to run the svelte app locally, you can run the following commands in your terminal after downloading node and cloning this github repository.

  1. download Node.js
  2. clone this repository
  3. run the following commands:
cd svelte-app
npm install
npm run dev

Hosting a server

The server folder contains instructions on how to run an earthstar server in order to host the shared database.

Pointing the web app to the server

The server address can be manually added by users through the UI by clicking the top right button and then selecting the Show Server Settings button. Users can then input the server's ip address in the text input field.

Alternatively, an admin can input the server address in the .env file in the svelte-app folder. You simply need to copy and rename the .env.example file found in the svelte-app folder and insert the server's address.

Deploying the application

With gh-pages, it is possible to quickly build and deploy with the following commands:

npm run build
npm run deploy

Moderation

The app contains a Delete Tool that allows for moderation. Ephemeral documents can be deleted by setting their deleteAfter properties in the very near future. Non-ephemeral documents' data can be wiped to get rid of undesirable content. In order to achieve this, you will need to:

  1. Enable the Delete Tool
  2. Obtain the undesirable document's path

Enabling the Delete Tool

If you're running the app locally and wish to enable the DeleteTool functionality, you can do so by uncommenting a specific block of code:

  1. Navigate to the file: svelte-app/src/lib/GridView.svelte
  2. Go to lines 434 to 437 in the above file.
  3. Uncomment the <DeleteTool /> section by removing the surrounding <!-- and -->.

From this:

<!--
<DeleteTool />
-->

To this:

<DeleteTool />

Finding the Document Path

To identify the path of any document:

  • Using the App Interface: Once an artefact is selected, the path to that document can be viewed in the artefact metadata located in the sidebar.

  • Checking the Source Code: If the artefact can't be selected through the interface, you can find its path by inspecting the source code. Look for the data-path attribute of the artefact icon you would like to delete. For instance:

<img src="icons/mountain-phase-5-02.png" alt="a mountain made of text is in phase #1" data-path="/documents/1/1/1695057834045/!shared-from-the-studio-by-bort.md" class=" s-CYjQHmkSPAe4">

Document Management

  • In the Studio: Use the Wipe button. Documents within the studio should be wiped. This means removing the document's data. Empty documents are filtered out and not shown in the app.

  • In the Commons: Use the Delete button. Since the Commons uses ephemeral documents, they can be directly deleted via their deleteAfter properties.

Building with Earthstar

We use github pages to host prototypes found in the web folder. The active prototype can be found at hyphacoop.github.io/restructuring-futures

Code of Conduct

This project has a Code of Conduct. The Restructuring Futures project team is dedicated to providing a harassment-free environment for everyone, regardless of gender, gender identity and expression, sexual orientation, disability, physical appearance, body size, race, age, religion or technical skill level.

In order to try and remove obstacles to participation, we have adopted an explicitly-documented code to communicate our expectations for conduct within the community. We expect all people engaging with the project to have read the code. If you have any questions please email project.rsfutures@hypha.coop or to report a violation please email Udit directly: udit@hypha.coop.

Curious? Want to know more?

You can email project.rsfutures@hypha.coop to get ahold of all of us at Hypha!

License

Restructuring Futures Public Notebook content is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License, the text of which is included in the repository here.

All code at github.com/hyphacoop/restructuring-futures/ is licensed under a GNU General Public License v3.0.