structables/README.md

51 lines
2 KiB
Markdown
Raw Normal View History

2023-06-01 21:30:41 +00:00
<div align="center">
2023-06-01 21:32:04 +00:00
<img src="static/img/logo.png">
<h1>Structables</h1>
An open source alternative front-end to Instructables. This is a fork of <a href="https://codeberg.org/indestructables/indestructables">snowcatridge10's Indestructables</a> to get rid of Selenium. Indestructables itself is a fork of <a href="https://git.vern.cc/cobra/Destructables">Cobra's Destructables</a>.
2023-07-19 06:25:41 +00:00
<ul>
<li>
<a href="https://matrix.private.cf/#/#structables:private.coffee">Private.coffee Matrix Room</a>
</li>
2023-07-19 06:25:41 +00:00
<li>
<a href="https://matrix.to/#/#indestructables:fedora.im">snowcatridge10's Matrix Room</a>
</li>
<li>
<a href="https://mto.vern.cc/#/%23cobra-frontends:vern.cc">Cobra's Matrix Room</a>
</li>
</ul>
2023-06-01 23:25:13 +00:00
2023-06-01 21:30:41 +00:00
</div>
2023-06-01 21:25:13 +00:00
# Instances
| URL | Provided by | Country | Comments |
2023-07-19 06:25:41 +00:00
| ---------------------------------------------------------------------------------- | ----------------------------------------- | ------- | -------- |
| [https://structables.private.coffee/](https://structables.private.coffee/) | [Private.coffee](https://private.coffee/) | Austria | |
2023-06-01 21:25:13 +00:00
# Run your own instance
2023-06-01 21:25:13 +00:00
## Dependencies
First, create a virtual environment with `python3 -m venv venv` and activate it with `source venv/bin/activate`. Then, install the dependencies with:
2023-06-01 21:25:13 +00:00
`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`
2023-06-01 21:25:13 +00:00
## Production
2023-06-01 21:25:13 +00:00
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
2023-06-01 21:25:13 +00:00
## Development
2023-06-01 21:25:13 +00:00
1. Clone the repository
2. Run `python3 main.py`
3. Connect to http://localhost:8002
2023-07-19 06:25:41 +00:00
## 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.