PrivateCoffee/structables
4
0
Fork 1
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
An open source alternative front-end to Instructables.
64 commits 1 branch 10 tags 15 MiB
Python 66.3%
HTML 25.5%
CSS 7.3%
Dockerfile 0.5%
Shell 0.4%
Find a file
Kumi de11b2843d
feat: bump version to 0.2.1, update .gitignore 
Incremented the project version to 0.2.1, preparing for a new release with minor improvements and bug fixes. Additionally, refined the .gitignore file to explicitly include the distribution directory, ensuring build artifacts are not accidentally committed to version control. This step aligns with best practices for Python project maintenance and distribution.
2024-05-23 09:05:26 +02:00
src/structables feat: Introduce pyproject.toml for build configuration 2024-05-23 08:06:36 +02:00
.gitignore feat: bump version to 0.2.1, update .gitignore 2024-05-23 09:05:26 +02:00
cronjob.txt add cronjob text file 2023-06-03 17:44:44 -04:00
LICENSE first commit 2023-06-01 17:25:13 -04:00
pyproject.toml feat: bump version to 0.2.1, update .gitignore 2024-05-23 09:05:26 +02:00
README.md refactor: streamline README and enhance project visibility 2024-05-23 08:27:21 +02:00

README.md

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.

Support Private.coffee! Matrix PyPI PyPI - Python Version PyPI - License Latest Git Commit

Instances

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

To add your own instance to this list, please open a pull request or issue.

Run your own instance

Production

  1. Create a virtual environment: python3 -m venv venv
  2. Activate the virtual environment: source venv/bin/activate
  3. Install the packages: pip install structables uwsgi
  4. Run uwsgi --plugin python3 --http-socket 0.0.0.0:8002 --module structables.main:app --processes 4 --threads 4
  5. Point your reverse proxy to http://localhost:8002 and (optionally) serve static files from the venv/lib/pythonX.XX/site-packages/structables/static directory
  6. Connect to your instance under your domain

Development

  1. Clone the repository: git clone https://git.private.coffee/privatecoffee/structables.git && cd structables
  2. Create a virtual environment: python3 -m venv venv
  3. Activate the virtual environment: source venv/bin/activate
  4. Install in editable mode: pip install -e .
  5. Run structables
  6. 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.