Merge pull request #274 from maykinmedia/feature/rename-app

[#241] Rename app

.github/workflows/ci.yml

@@ -11,7 +11,7 @@ on:
   workflow_dispatch:
 
 env:
-  IMAGE_NAME: maykinmedia/archiefvernietigingscomponent
+  IMAGE_NAME: maykinmedia/archiefbeheercomponent
 
 jobs:
   tests:
@@ -45,7 +45,7 @@ jobs:
           python src/manage.py collectstatic --noinput --link
           coverage run src/manage.py test src
         env:
-          DJANGO_SETTINGS_MODULE: archiefvernietigingscomponent.conf.ci
+          DJANGO_SETTINGS_MODULE: archiefbeheercomponent.conf.ci
           SECRET_KEY: dummy
           DB_USER: postgres
           DB_PASSWORD: ''

.gitignore

@@ -34,9 +34,9 @@ local.py
 /doc/_templates
 
 # Static files generated by gulp
-src/archiefvernietigingscomponent/static/css/**/*.css
-src/archiefvernietigingscomponent/static/css/**/*.css.map
+src/archiefbeheercomponent/static/css/**/*.css
+src/archiefbeheercomponent/static/css/**/*.css.map
 
-src/archiefvernietigingscomponent/static/fonts/
-src/archiefvernietigingscomponent/static/js/
+src/archiefbeheercomponent/static/fonts/
+src/archiefbeheercomponent/static/js/
 private-media/

AUTHORS

@@ -1,10 +1,10 @@
-The Archiefvernietigingscomponent was originally developed in the municipality
+The ArchiefBeheerComponent was originally developed in the municipality
 of Utrecht and called the Record Management App. Later, it was turned into a
 Common Ground project backed by several municipalities.
 
 Here is an inevitably incomplete list of MUCH-APPRECIATED CONTRIBUTORS --
 people who laid the groundwork, have submitted patches, reported bugs, added
-translations, helped answer questions, and generally made the components that 
+translations, helped answer questions, and generally made the components that
 much better:
 
     Anna Shamray <[email protected]>
@@ -17,4 +17,4 @@ A big THANK YOU goes to:
     The municipality of Utrecht and Delft for their active support in creating
     this application.
 
-    All people behind Common Ground for their enthusiasm and vision.
+    All people behind Common Ground for their enthusiasm and vision.

CONTRIBUTING.md

@@ -4,40 +4,40 @@ If you want to contribute, we ask you to follow these guidelines.
 
 ## Reporting bugs
 
-If you have encountered a bug in this project, please check if an issue already 
-exists in the list of existing [issues][issues]. If such an issue does not 
-exist, you can create a [new issue][new_issue]. When writing the bug report, 
+If you have encountered a bug in this project, please check if an issue already
+exists in the list of existing [issues][issues]. If such an issue does not
+exist, you can create a [new issue][new_issue]. When writing the bug report,
 try to add a clear example that shows how to reproduce said bug.
 
 ## Adding new features
 
-Before making making changes to the code, we advise you to first check the list 
-of existing [issues][issues] for this project to see if an issue for the 
-suggested changes already exists. If such an issue does not exist, you can 
-create a [new issue][new_issue]. Creating an issue gives an opportunity for 
+Before making making changes to the code, we advise you to first check the list
+of existing [issues][issues] for this project to see if an issue for the
+suggested changes already exists. If such an issue does not exist, you can
+create a [new issue][new_issue]. Creating an issue gives an opportunity for
 other developers to give tips even before you start coding.
 
 ### Code style
 
 To keep the code clean and readable, this project uses:
 
 - [`isort`](https://github.com/timothycrosley/isort) to order the imports
-- [`black`](https://github.com/psf/black) to format the code and keep diffs for 
+- [`black`](https://github.com/psf/black) to format the code and keep diffs for
   pull requests small
 - [`flake8`](https://github.com/PyCQA/flake8) to clean up code (removing unused
   imports, etc.)
 
-Whenever a branch is pushed or a pull request is made, the code will be checked 
-in CI by the tools mentioned above, so make sure to install these tools and run 
+Whenever a branch is pushed or a pull request is made, the code will be checked
+in CI by the tools mentioned above, so make sure to install these tools and run
 them locally before pushing branches/making pull requests.
 
-This project aims to meet the criteria of the 
-[Standard for Public Code][Standard_for_Public_Code]. Please make sure that 
+This project aims to meet the criteria of the
+[Standard for Public Code][Standard_for_Public_Code]. Please make sure that
 your pull requests are compliant, that will make the reviews quicker.
 
 ### Forking the repository
 
-In order to implement changes to this project when you do not have rights for 
+In order to implement changes to this project when you do not have rights for
 this [repository][repository], you must first fork the repository. Once the
  repository is forked, you can clone it to your local machine.
 
@@ -47,30 +47,30 @@ On your local machine, create a new branch, and name it like:
 - `feature/some-new-feature`, if the changes implement a new feature
 - `issue/some-issue`, if the changes fix an issue
 
-Once you have made changes or additions to the code, you can commit them (try 
-to keep the commit message descriptive but short). If an issue already exists 
-in the list of existing [issues][issues] for the changes you made, be sure to 
-format your commit message like 
-`:gitmoji: Fixes #<issue_id> -- description of changes made`, where 
-`<issue_id>` corresponds to the number of the issue on GitHub. To demonstrate 
-that the changes implement the new feature/fix the issue, make sure to also add 
+Once you have made changes or additions to the code, you can commit them (try
+to keep the commit message descriptive but short). If an issue already exists
+in the list of existing [issues][issues] for the changes you made, be sure to
+format your commit message like
+`:gitmoji: Fixes #<issue_id> -- description of changes made`, where
+`<issue_id>` corresponds to the number of the issue on GitHub. To demonstrate
+that the changes implement the new feature/fix the issue, make sure to also add
 tests to the existing Django testsuite.
 
 ### Making a pull request
 
-If all changes have been committed, you can push the branch to your fork of the 
-repository and create a pull request to the `master` branch of this project's 
-repository. Your pull request will be reviewed, if applicable, feedback will be 
+If all changes have been committed, you can push the branch to your fork of the
+repository and create a pull request to the `master` branch of this project's
+repository. Your pull request will be reviewed, if applicable, feedback will be
 given and if everything is approved, it will be merged.
 
 ### Reviews on releases
 
-All pull requests will be reviewed by a project memeber before they are merged 
-to a release branch. 
+All pull requests will be reviewed by a project memeber before they are merged
+to a release branch.
 
 
-[issues]: https://github.com/maykinmedia/archiefvernietigingscomponent/issues
-[new_issue]: https://github.com/maykinmedia/archiefvernietigingscomponent/issues/new/choose
+[issues]: https://github.com/maykinmedia/archiefbeheercomponent/issues
+[new_issue]: https://github.com/maykinmedia/archiefbeheercomponent/issues/new/choose
 [mailinglist]: t.b.d.
 [Standard_for_Public_Code]: https://standard.publiccode.net
-[repository]: https://github.com/maykinmedia/archiefvernietigingscomponent
+[repository]: https://github.com/maykinmedia/archiefbeheercomponent

Dockerfile

@@ -71,7 +71,7 @@ COPY --from=backend-build /usr/local/bin/celery /usr/local/bin/celery
 COPY --from=backend-build /app/src/ /app/src/
 
 # copy frontend build statics
-COPY --from=frontend-build /app/src/archiefvernietigingscomponent/static /app/src/archiefvernietigingscomponent/static
+COPY --from=frontend-build /app/src/archiefbeheercomponent/static /app/src/archiefbeheercomponent/static
 
 # copy source code
 COPY ./src /app/src
@@ -84,7 +84,7 @@ USER maykin
 
 ARG COMMIT_HASH
 ENV GIT_SHA=${COMMIT_HASH}
-ENV DJANGO_SETTINGS_MODULE=archiefvernietigingscomponent.conf.docker
+ENV DJANGO_SETTINGS_MODULE=archiefbeheercomponent.conf.docker
 
 ARG SECRET_KEY=dummy
 

INSTALL.rst

@@ -44,8 +44,8 @@ development machine.
 
    .. code-block:: bash
 
-       $ git clone [email protected]:maykinmedia/archiefvernietigingscomponent.git
-       $ cd archiefvernietigingscomponent
+       $ git clone [email protected]:maykinmedia/archiefbeheercomponent.git
+       $ cd archiefbeheercomponent
 
 3. Install all required libraries.
    **Tip:** You can use the ``bootstrap.py`` script to install the requiments
@@ -94,7 +94,7 @@ development machine.
 
 
 **Note:** If you are making local, machine specific, changes, add them to
-``src/archiefvernietigingscomponent/conf/local.py``. You can base this file on the
+``src/archiefbeheercomponent/conf/local.py``. You can base this file on the
 example file included in the same directory.
 
 **Note:** You can run watch-tasks to compile `Sass`_ to CSS and `ECMA`_ to JS
@@ -114,7 +114,7 @@ When updating an existing installation:
 
    .. code-block:: bash
 
-       $ cd archiefvernietigingscomponent
+       $ cd archiefbeheercomponent
        $ source env/bin/activate
 
 2. Update the code and libraries:
@@ -141,7 +141,7 @@ To run the test suite:
 
 .. code-block:: bash
 
-    $ python src/manage.py test archiefvernietigingscomponent
+    $ python src/manage.py test archiefbeheercomponent
 
 Configuration via environment variables
 ---------------------------------------
@@ -152,9 +152,9 @@ file or as part of the ``(post)activate`` of your virtualenv.
 
 * ``SECRET_KEY``: the secret key to use. A default is set in ``dev.py``
 
-* ``DB_NAME``: name of the database for the project. Defaults to ``archiefvernietigingscomponent``.
-* ``DB_USER``: username to connect to the database with. Defaults to ``archiefvernietigingscomponent``.
-* ``DB_PASSWORD``: password to use to connect to the database. Defaults to ``archiefvernietigingscomponent``.
+* ``DB_NAME``: name of the database for the project. Defaults to ``archiefbeheercomponent``.
+* ``DB_USER``: username to connect to the database with. Defaults to ``archiefbeheercomponent``.
+* ``DB_PASSWORD``: password to use to connect to the database. Defaults to ``archiefbeheercomponent``.
 * ``DB_HOST``: database host. Defaults to ``localhost``
 * ``DB_PORT``: database port. Defaults to ``5432``.
 
@@ -168,43 +168,43 @@ Docker
 The easiest way to get the project started is by using `Docker Compose`_.
 
 1. Clone or download the code from `Github`_ in a folder like
-   ``archiefvernietigingscomponent``:
+   ``archiefbeheercomponent``:
 
    .. code-block:: bash
 
-       $ git clone [email protected]:maykinmedia/archiefvernietigingscomponent.git
-       Cloning into 'archiefvernietigingscomponent'...
+       $ git clone [email protected]:maykinmedia/archiefbeheercomponent.git
+       Cloning into 'archiefbeheercomponent'...
        ...
 
-       $ cd archiefvernietigingscomponent
+       $ cd archiefbeheercomponent
 
 2. Start the database and web services:
 
    .. code-block:: bash
 
        $ docker-compose up -d
-       Starting archiefvernietigingscomponent_db_1 ... done
-       Starting archiefvernietigingscomponent_web_1 ... done
+       Starting archiefbeheercomponent_db_1 ... done
+       Starting archiefbeheercomponent_web_1 ... done
 
    It can take a while before everything is done. Even after starting the web
    container, the database might still be migrating. You can always check the
    status with:
 
    .. code-block:: bash
 
-       $ docker logs -f archiefvernietigingscomponent_web_1
+       $ docker logs -f archiefbeheercomponent_web_1
 
 3. Create an admin user and load initial data. If different container names
    are shown above, use the container name ending with ``_web_1``:
 
    .. code-block:: bash
 
-       $ docker exec -it archiefvernietigingscomponent_web_1 /app/src/manage.py createsuperuser
+       $ docker exec -it archiefbeheercomponent_web_1 /app/src/manage.py createsuperuser
        Username: admin
        ...
        Superuser created successfully.
 
-       $ docker exec -it archiefvernietigingscomponent_web_1 /app/src/manage.py loaddata admin_index groups
+       $ docker exec -it archiefbeheercomponent_web_1 /app/src/manage.py loaddata admin_index groups
        Installed 5 object(s) from 2 fixture(s)
 
 4. Point your browser to ``http://localhost:8000/`` to access the project's
@@ -226,29 +226,29 @@ The easiest way to get the project started is by using `Docker Compose`_.
    system you can run ``docker system prune``.
 
 .. _Docker Compose: https://docs.docker.com/compose/install/
-.. _Github: https://github.com/maykinmedia/archiefvernietigingscomponent/
+.. _Github: https://github.com/maykinmedia/archiefbeheercomponent/
 
 
 More Docker
 -----------
 
 If you just want to run the project as a Docker container and connect to an
 external database, you can build and run the ``Dockerfile`` and pass several
-environment variables. See ``src/archiefvernietigingscomponent/conf/docker.py`` for
+environment variables. See ``src/archiefbeheercomponent/conf/docker.py`` for
 all settings.
 
 .. code-block:: bash
 
-    $ docker build -t archiefvernietigingscomponent
+    $ docker build -t archiefbeheercomponent
     $ docker run \
         -p 8000:8000 \
         -e DATABASE_USERNAME=... \
         -e DATABASE_PASSWORD=... \
         -e DATABASE_HOST=... \
-        --name archiefvernietigingscomponent \
-        archiefvernietigingscomponent
+        --name archiefbeheercomponent \
+        archiefbeheercomponent
 
-    $ docker exec -it archiefvernietigingscomponent /app/src/manage.py createsuperuser
+    $ docker exec -it archiefbeheercomponent /app/src/manage.py createsuperuser
 
 Building and publishing the image
 ---------------------------------
@@ -308,7 +308,7 @@ Settings
 ========
 
 All settings for the project can be found in
-``src/archiefvernietigingscomponent/conf``.
+``src/archiefbeheercomponent/conf``.
 The file ``local.py`` overwrites settings from the base configuration.