https://github.com/idlesign/webscaff

Simplified scaffolding for web applications
https://github.com/idlesign/webscaff

automation certbot debian django fabric postgresql scaffolding systemd uwsgi

Last synced: 4 months ago
JSON representation

Simplified scaffolding for web applications

• Host: GitHub
• URL: https://github.com/idlesign/webscaff
• Owner: idlesign
• License: bsd-3-clause
• Created: 2019-09-29T05:52:20.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-12-09T14:56:33.000Z (about 2 years ago)
• Last Synced: 2024-09-29T16:43:46.959Z (4 months ago)
• Topics: automation, certbot, debian, django, fabric, postgresql, scaffolding, systemd, uwsgi
• Language: Python
• Homepage: https://github.com/idlesign/webscaff
• Size: 129 KB
• Stars: 4
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG
  • Contributing: CONTRIBUTING
  • License: LICENSE

Awesome Lists containing this project

README

        
webscaff

========

https://github.com/idlesign/webscaff

|release| |lic| |coverage|

.. |release| image:: https://img.shields.io/pypi/v/webscaff.svg

    :target: https://pypi.python.org/pypi/webscaff

.. |lic| image:: https://img.shields.io/pypi/l/webscaff.svg

    :target: https://pypi.python.org/pypi/webscaff

.. |coverage| image:: https://img.shields.io/coveralls/idlesign/webscaff/master.svg

    :target: https://coveralls.io/r/idlesign/webscaff

Description

-----------

*Remote scaffolding and orchestration for web applications*

Used stack

~~~~~~~~~~

* **Debian**-based OS (Ubuntu 18.04, 20.04, 22.04 tested) as a basis.

* **Git** for source code updates.

* **Systemd** to securely run your webservice.

* **PostgreSQL** as a reliable DBMS.

* **uWSGI** as a platform (handling routing, static, background tasks, etc.).

* **Python 3** to cover your needs.

* **Django** as a rich and solid webframework.

And also:

* **Certbot** integration for free HTTPS certificates (webroot plugin).

* SSH Agent forwarding for project code updates on remote using keys from your system.

A taste of it

-------------

After install the ``webscaff`` command is available.

.. code-block:: bash

    ; We rollout project skeleton using `makeapp`.

    $ makeapp new myproject -d "My webscaff project" -t webscaff /home/some/here

    ; Switch into project directory containing `wscaff.yml` which is used by webscaff.

    $ cd /home/some/here

    ; Get basic information about the remote.

    $ webscaff info

    ; Prepare the remote for you web application.

    $ webscaff run.initialize

Webscaff offers a number of useful command, among them:

.. code-block:: bash

    ; Rollout a new version of yor project from repository.

    $ webscaff rollout

    ; Make a backup and download to local directory.

    $ webscaff run.backup

More commands are available.

Detailed instructions could be found in the documentation.

Documentation

-------------

http://webscaff.readthedocs.org/