engineering/remarkbox
1
0
Fork 0
Code Issues 3 Pull requests 1 Projects Releases Packages Wiki Activity Actions

modified: Makefile

Browse source 
modified:   README.rst
This commit is contained in:
Russell Ballestrini 2025-03-01 17:41:12 -05:00
parent e37f7e4037
commit 9d1393ebae
2 changed files with 6 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

2
Makefile
View file

@ -101,7 +101,7 @@ install-from-pypi: venv config install init-db
# Install and setup from source (editable mode)
install-from-source: venv config install-source-dev-and-test init-db
# Install and setup from source (editable mode)
# Install and setup from source (no edit)
install-from-source-prod: venv config install-source-prod init-db
# -----------------------------------------------------------------------------

12
README.rst
View file

@ -1,10 +1,14 @@
Quick Start: Operating a Server with PyPI or Source Code
==============================================================
This Makefile‑based workflow lets you choose between installing Remarkbox from PyPI packages or directly from the source code (editable mode). Both flows create a virtual environment in ``./env`` and store configuration and SQLite data in the persistent ``./data`` directory.
This ``Makefile`` based workflow lets you choose between installing Remarkbox from PyPI packages or directly from the source code (editable mode). Both flows create a virtual environment in ``./env`` and store configuration and SQLite data in the persistent ``./data`` directory.
1. **Install Remarkbox**
- Get the ``Makefile`` in your present working direcory, run::
wget "https://git.unturf.com/engineering/remarkbox/remarkbox/-/blob/main/Makefile"
- For a PyPI Installation, run::
make install-from-pypi
@ -29,12 +33,6 @@ This Makefile‑based workflow lets you choose between installing Remarkbox from
Other commands—such as ``make test``, and ``make http`` operate within this environment.
For a production installation, additional meta packages are available, for example:
..code-block:: bash
pip install remarkbox[prod]
Remarkbox
==============================================