Skip to content

Commit

Permalink
Update instructions to setup atramhasis projects using cookiecutter
Browse files Browse the repository at this point in the history
Delete obsolete README files
  • Loading branch information
goessebr committed Jun 28, 2024
1 parent b913292 commit 34355ec
Show file tree
Hide file tree
Showing 3 changed files with 61 additions and 87 deletions.
44 changes: 0 additions & 44 deletions cookiecutters/demo/README.rst

This file was deleted.

41 changes: 0 additions & 41 deletions cookiecutters/scaffold/README.rst

This file was deleted.

63 changes: 61 additions & 2 deletions docs/source/customisation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,68 @@ instance with only these default settings.
Creating your own project
=========================

Follow the README at `atramhasis scaffold cookiecutter <https://github.com/OnroerendErfgoed/atramhasis/tree/develop/cookiecutters/scaffold/README.rst>`_
Requirements
------------

* Python 3.9+
* npm

Usage
-----


1. Preferably, create a virtual environment specifically to setup your project.
You can alternatively use the atramhasis_dev environment that you created following the
instructions in https://atramhasis.readthedocs.io/en/latest/development.html#general-installation.

.. code-block:: bash
# create a new virtual environment to setup your project
$ python -m venv atramhasis_setup
$ . atramhasis_dev/bin/activate
# Make sure pip and pip-tools are up to date
$ pip install --upgrade pip pip-tools
$ pip install --upgrade cookiecutter
2. Use cookiecutter to generate an atramhasis project

.. code-block:: bash
$ cookiecutter gh:OnroerendErfgoed/atramhasis --directory cookiecutters/scaffold
3. Create a virtual environment and install requirements

.. code-block:: bash
# create a new virtual environment for the project, fe python -m venv $HOME/.virtualenvs/atramhasis_demo_venv
# Change directory into your newly created project if not already there.
# The [dev] optional requirement will install the waitress WSGI server.
# You are of course free to choose another.
$ pip install -e .[dev]
# Install dependencies
$ pip-sync requirements-dev.txt
# Install Inventaris in dev mode
$ pip install -e .




4. Setup database

.. code-block:: bash
$ alembic upgrade head
5. Run server

.. code-block:: bash
$ cd <root of repo>
$ pserve development.ini
This gives you a clean slate to start your customisations on.
Database
--------
Expand Down

0 comments on commit 34355ec

Please sign in to comment.