wutta/wuttjamaican
3
0
Fork 0
Code Activity

docs: cleanup quickstart a bit, add some links

Browse source
This commit is contained in:
Lance Edgar 2024-12-03 09:31:43 -06:00
parent 028c64fc12
commit de551c9bbd
1 changed files with 12 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
docs/narr/install/quickstart.rst
View file

@ -22,35 +22,39 @@ Make a parent folder for all source code:
mkdir -p ~/src mkdir -p ~/src
Make a :term:`virtual environment` for your project: Make and activate a new :term:`virtual environment` for your project:
.. code-block:: sh .. code-block:: sh
cd /path/to/envs cd /path/to/envs
python3 -m venv poser python3 -m venv poser
source poser/bin/activate
Make a new e.g. ``poser`` database in PostgreSQL (or MySQL). Make a new e.g. ``poser`` database in PostgreSQL (or MySQL).
Install and run cookiecutter with wuttaweb template: Install and run `cookiecutter <https://cookiecutter.readthedocs.io/>`_
with `wuttaweb template
<https://forgejo.wuttaproject.org/wutta/cookiecutter-wuttaweb>`_:
.. code-block:: sh .. code-block:: sh
cd /path/to/envs/poser pip install cookiecutter
bin/pip install cookiecutter cookiecutter -o ~/src git+https://forgejo.wuttaproject.org/wutta/cookiecutter-wuttaweb
bin/cookiecutter -o ~/src git+https://forgejo.wuttaproject.org/wutta/cookiecutter-wuttaweb
Assuming you now have project code at ``~/src/poser`` then install Assuming you now have project code at ``~/src/poser`` then install
that and run the app installer: that and run the app installer. Note the 2nd command name will depend
on your project:
.. code-block:: sh .. code-block:: sh
bin/pip install -e ~/src/poser pip install -e ~/src/poser
bin/poser install poser install
If all goes well, you can run the web app with: If all goes well, you can run the web app with:
.. code-block:: sh .. code-block:: sh
cd /path/to/envs/poser
bin/pserve --reload file+ini:app/web.conf bin/pserve --reload file+ini:app/web.conf
And browse it at http://localhost:9080 And browse it at http://localhost:9080