PrivateCoffee/structables
4
0
Fork 1
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
An open source alternative front-end to Instructables.
62 commits 1 branch 14 tags 15 MiB
Python 66.5%
HTML 26.6%
CSS 6%
Dockerfile 0.5%
Shell 0.4%
Find a file
Kumi 85d5c88294
feat: Introduce pyproject.toml for build configuration 
Migrated project dependencies and metadata into a newly added `pyproject.toml`, aligning with modern Python packaging practices. Removed `requirements.txt` as dependencies are now specified in the unified project configuration. Restructured the project by moving Python code, static assets, and templates into a `src/structables` directory to encapsulate project components better and facilitate packaging. Moreover, refactor `main.py` to read environment variables earlier, streamline argument parsing, and ensure configurations are correctly applied before the Flask app initialization. This reorganization supports better project scalability, simplifies the build process, and enhances maintainability by consolidating project configurations and dependencies.

Note: The usage of `pyproject.toml` requires tools that support PEP 518 and might necessitate updates to CI/CD pipelines or developer workflows.
2024-05-23 08:06:36 +02:00
src/structables feat: Introduce pyproject.toml for build configuration 2024-05-23 08:06:36 +02:00
.gitignore Update .gitignore and enhance project structure 2024-01-17 16:43:51 +01: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: Introduce pyproject.toml for build configuration 2024-05-23 08:06:36 +02:00
README.md Consolidated matrix rooms and source links 2024-02-15 16:27:34 +01: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.

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.