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

Merge branch 'main' into 'main'

Browse source 
Fix README spelling/formatting

See merge request engineering/remarkbox/remarkbox!2
This commit is contained in:
Russell Ballestrini 2025-01-09 13:09:36 +00:00
commit 3114737c40
1 changed files with 9 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

18
README.rst
View file

@ -6,13 +6,13 @@ What is RemarkBox?:
Works anywhere that supports HTML.
Original Developer:
Russell Ballestrini (https://russell.ballestrini.net)
Russell Ballestrini (https://russell.ballestrini.net)
Project Goals
=============
Note:
These goals are not in priority order.
These goals are not in priority order.
#. To be a suitable for:
@ -72,13 +72,13 @@ Functional testing environment
To setup a "functional testing" environment on your personal workstation, open three terminal shells.
In the first shell, run a copy of remarkbox using:
In the first shell, run a copy of Remarkbox using:
.. code-block:: bash
make serve
In the second shell, run a "mock" simple HTTP webserver to serve index.html:
In the second shell, run a "mock" simple HTTP web server to serve index.html:
.. code-block:: bash
@ -90,7 +90,7 @@ In the third shell, run a "mock" SMTP server to catch log in emails:
make smtp
Now browse to http://127.0.0.1:8000 and index.html will load and will have an embeded copy of Remarkbox which running on localhost.
Now browse to http://127.0.0.1:8000 and index.html will load and will have an embedded copy of Remarkbox which running on localhost.
If you attempt to log in, your third shell will capture the email and you can copy / paste the verification link to log in!
@ -142,7 +142,7 @@ database with the state of the model:
.. code-block:: bash
alembic -c development.ini revision --autogenerate -m "autogenerated indicies."
alembic -c development.ini revision --autogenerate -m "autogenerated indices."
You should review the recommended migration script before `upgrade`.
@ -150,7 +150,7 @@ You should review the recommended migration script before `upgrade`.
Cleaning the homepage
========================
Sometimes (all the times) it's nice to clear all the test comments from the
Sometimes (all the times) it's nice to clear all the test comments from
the homepage of our marketing site. Use this query.
.. code-block:: sql
@ -194,14 +194,14 @@ Here is a full `pshell` script to modify every `Node` who has a `Uri`:
# get all Uri objects.
uris = m.uri.get_all_uris(request.dbsession)
# interate over all Uri objects.
# iterate over all Uri objects.
for uri in uris:
# modify the Uri's related Node.
uri.node.has_uri = True
# add the related Node object to the sqlalchemy session.
request.dbsession.add(uri.node)
# flush / commit all changes stored the the sqlachemy session.
# flush / commit all changes stored the sqlalchemy session.
request.dbsession.flush()
# commit/close the database transaction to really make changes.