Kumi
0b4676b720
Updated the project documentation and .gitignore for a cleaner structure and enhanced visibility. The README now integrates dynamic badges for real-time status like support links, PyPI version, and latest commit info, offering a quick overview of the project status at a glance. These changes aim to make the project more accessible to potential contributors and users by providing essential information more efficiently. Additionally, the `.gitignore` file has been updated to include the `dist/` directory, preventing the accidental inclusion of distribution files in the repository, thus maintaining a cleaner project structure. The restructuring of the README content, including a simplified approach to setting up development and production environments, aligns with best practices, making it easier for new contributors to get started. Furthermore, the changes enhance project documentation coherence and readability by embedding relevant badges and updating linkage paths for better navigation.
44 lines
2.7 KiB
Markdown
44 lines
2.7 KiB
Markdown
<img align="right" src="src/structables/static/img/logo.png">
|
|
|
|
# Structables
|
|
|
|
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>.
|
|
|
|
[](https://private.coffee)
|
|
[](https://matrix.to/#/#structables:private.coffee)
|
|
[](https://pypi.org/project/structables/)
|
|
[](https://pypi.org/project/structables/)
|
|
[](https://pypi.org/project/structables/)
|
|
[](https://git.private.coffee/privatecoffee/structables)
|
|
|
|
## Instances
|
|
|
|
| URL | Provided by | Country | Comments |
|
|
| -------------------------------------------------------------------------- | ----------------------------------------- | ------- | -------- |
|
|
| [https://structables.private.coffee/](https://structables.private.coffee/) | [Private.coffee](https://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](LICENSE) file for more information.
|