myresearch

This application can be run in one of three modes:

• Local: runs the application in development mode on your own machine.
• Docker (development): runs interactive development servers in Docker containers.
• Docker (production): runs the application in production mode.

The differences are outlined below.

| | Local | Docker dev | Docker prod | | --- | --- | --- | --- | | PostgreSQL database | On host machine | In container | In container | | Frontend server | Nuxt development server | Nuxt development server in container | NGINX server serving a minimized static build | | Backend server | TBD | TBD | TBD | | Live-reloading on code changes | ✔ | ✔ | ❌ | | Ports available | 3000 (frontend) | 5000 (NGINX), 3000 (frontend) | 5000 (NGINX) | | Logging | Console | TBD | TBD |

Running the application locally

Prerequisites

• Node.js 22.16.0 (LTS) has been tested. Other versions may work.
• Python 3.11 has been tested. Other versions may work.
• PostgreSQL (for local database)

Steps

1. Clone the repository and navigate to it: bash git clone https://github.com/CentreForDigitalHumanities/myresearch cd myresearch

2. Install frontend dependencies: bash cd frontend npm install

3. Start the frontend: bash npm run dev

4. Open your browser and navigate to http://localhost:3000 to visit the application!

   (TODO: add backend install instructions).

5. For development, the backend requires supplementing the settings.py with a local_settings.py file, which contains the following settings:

   ``` CORSALLOWALLORIGINS = True CORSALLOW_CREDENTIALS = True

   CSRFTRUSTEDORIGINS = ["http://*:3000"] ```

6. Create a new local development database. The first PostgreSQL start-up will normally do this for you, but in case you need to do this manually, follow this step. The Django development server expects a database with the following details. (This can be changed as needed in settings.py):

7. DB name: myresearch

8. Host: localhost

9. Port: 5432

10. User: myresearch

11. Password: myresearch

The file backend/create_db.sql can be used to create the database and user with the correct permissions. Run it as follows.

bash psql -U <your-postgres-username> -f backend/create_db.sql

Note that this is not needed if you are using the provided Docker setup. Also, make sure to never use these standard settings in a production environment.

Running the application in Docker

This will start a Docker Compose network with the following containers:

Prerequisites

• Docker and Docker Compose installed on your machine.

Steps

1. Clone the repository: bash git clone https://github.com/CentreForDigitalHumanities/myresearch cd myresearch

2. Build the Docker images:

```bash # In development mode: docker compose --profile dev up --build -d

# In production mode: docker compose --profile prod up --build -d ```

For subsequent runs, you may omit `--build`, unless you switch branches, update dependencies or edit `compose.yml` or one of the `Dockerfile`s. This will ensure that the images are rebuilt with the latest changes.

1. Open your browser and navigate to http://localhost:5000 to visit the application!