PrivateCoffee/structables
4
0
Fork 1
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
An open source alternative front-end to Instructables.
72 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 bc9074fc2b
feat: implement dynamic content loading and config management 
Introduce dynamic loading of project data and streamlined configuration management. This update modularizes the codebase, separating routes and utilities for improved maintainability and scalability. It also adds a new configuration system to manage environment variables more efficiently, ensuring a seamless setup process for different environments. The refactor includes the addition of Typesense API key retrieval for enhanced search capabilities and the initialization of the application with environment-specific settings, providing a foundation for further feature development and optimization.

The change underscores a shift towards a more maintainable and scalable architecture, setting the stage for future enhancements and features. By organizing the route and utility functions into separate modules, the codebase becomes easier to navigate and extend. The new config management approach centralizes settings, aiding in the smooth adaptation to varying deployment conditions. Additionally, the introduction of dynamic project data loading aims to keep the content fresh and relevant, improving the user experience.

This commit marks a significant step in the project's evolution, streamlining its structure and paving the way for continuous improvement and growth.
2024-05-25 16:48:15 +02:00
src/structables feat: implement dynamic content loading and config management 2024-05-25 16:48:15 +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: implement dynamic content loading and config management 2024-05-25 16:48:15 +02:00
README.md feat: Update Matrix link and add issue-reporting guide 2024-05-23 17:15:13 +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.

Opening Issues

If you're having problems using Structables, or if you have ideas or feedback for us, feel free to open an issue in the Private.coffee Git or on Github.

Of course, you can also join our Matrix room to discuss your ideas with us.

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.