structables/README.md
Kumi dfe7882b12
Consolidated matrix rooms and source links
Removed several Matrix chat room links from the README and streamlined
the list of instances to enhance readability and maintain a focus on
primary resources. Updated footer source code references to point to a
singular, official repository for increased clarity and to reflect the
project's centralization efforts. This change should make the
documentation less cluttered and more user-friendly for new
contributors.
2024-02-15 16:27:34 +01:00

1.8 KiB

Structables

An open source alternative front-end to Instructables. This is a fork of snowcatridge10's Indestructables to get rid of Selenium. Indestructables itself is a fork of Cobra's Destructables.

Instances

URL Provided by Country Comments
https://structables.private.coffee/ Private.coffee Austria

Run your own instance

Dependencies

First, create a virtual environment with python3 -m venv venv and activate it with source venv/bin/activate. Then, install the dependencies with:

pip3 install -r requirements.txt.

For the production environment, you also need the uWSGI Python3 plugin. On Debian, it can be installed via apt install uwsgi-plugin-python3

Production

  1. Clone the repository
  2. Run uwsgi --plugin python3 --http-socket 0.0.0.0:8002 --wsgi-file main.py --callable app --processes 4 --threads 2
  3. Point your reverse proxy to http://localhost:8002

Development

  1. Clone the repository
  2. Run python3 main.py
  3. Connect to http://localhost:8002

License

This project, as well as the two projects it is based on, are licensed under the GNU Affero General Public License v3. See the LICENSE file for more information.