2
0
Fork 0

docs: update quick start to use cookiecutter

This commit is contained in:
Lance Edgar 2024-11-26 11:46:17 -06:00
parent affc19bac0
commit ecdfb2f6e0

View file

@ -14,31 +14,40 @@ From Generated Code
-------------------
Note that this section describes an app based on WuttaWeb (i.e. not
just WuttJamaican).
just WuttJamaican). We'll name it "Poser" for sake of example.
There is a tool to `generate new project code`_, on the Rattail Demo
site. Use it to download a ZIP file (e.g. ``poser.zip``) for your
project.
.. _generate new project code: https://demo.rattailproject.org/generated-projects/new/wutta
Make a local :term:`virtual environment` for your project.
Also make a new e.g. ``poser`` database in PostgreSQL (or MySQL).
Unzip and install the source code to the virtual environment, then run
the app installer:
Make a parent folder for all source code:
.. code-block:: sh
mkdir -p ~/src
unzip ~/Downloads/poser.zip -d ~/src
cd /path/to/venv
Make a :term:`virtual environment` for your project:
.. code-block:: sh
cd /path/to/envs
python3 -m venv poser
Make a new e.g. ``poser`` database in PostgreSQL (or MySQL).
Install and run cookiecutter with wuttaweb template:
.. code-block:: sh
cd /path/to/envs/poser
bin/pip install cookiecutter
bin/cookiecutter -o ~/src git+https://forgejo.wuttaproject.org/wutta/cookiecutter-wuttaweb
Assuming you now have project code at ``~/src/poser`` then install
that and run the app installer:
.. code-block:: sh
bin/pip install -e ~/src/poser
bin/poser install
Assuming all goes well, you can run the web app with:
If all goes well, you can run the web app with:
.. code-block:: sh