Table of Contents

1. Introduction
2. Technical Requirements
3. Local Development
4. Required Setup
5. Contributing

Introduction to MakeMyFlix

Welcome to MakeMyFlix, an innovative project designed to empower users to create their own "flix". A "flix" is a visual representation of a dataset, crafted to follow specific rules and present data in an accessible manner. By leveraging linked open data, MakeMyFlix simplifies the process of displaying complex datasets, making them easily understandable and available to the public.

Technical Requirements

This project relies on several services to run correctly

1. Postgress database service
2. S3 compatible file service
3. Node

Although each project can run on their own given the correct env variables, for development purposes we use the docker compose approach to make this easier to run.

Local Development

1. Clone the repository:

   git clone <repository-url>
   cd <repository-directory>

2. Set up environment variables:

   Copy the example environment files and modify them as needed:

   cp .env.example .env
   cp nuxt/.env.example nuxt/.env
   cp strapi/.env.example strapi/.env

3. Run the project:

   docker compose up

Required Setup

To make the Nuxt / Strapi connection a bit more secure, it requires a token. This is not something that is part of the installation and needs to be done afterwards.

1. Create superadmin account

   To create a superadmin account, goto: Strapi
   This only works if no superadmin account exists*

2. Create an API Token

   After creating the superadmin, goto: API Tokens
   After creating the token, copy the token and paste it inside the nuxt/.env file.

3. Restart services

   Unfortunately Nuxt needs to reload to get the new setup, so restart the docker compose to do so using docker compose restart

4. Stopping services

   Use (ctrl-c and) docker compose downto stop the running services and remove the containers.

Using MakeMyFlix

1. Create an new Flix

   Goto http://localhost:1000/create/ to create a new flix by entering the SPARQL-endpoint URL and the category and item queries (detail information on how to build these queries will be added, look at https://github.com/netwerk-digitaal-erfgoed/heritageflix-configs for examples)

2. Configure the design

   After saving the new Flix in step 1 you will enter the preview configuration dialog where you can personalize the UI of the Flix.

   Note: In this step you a token parameter is added in as part of the URL. You can update the new Flix by specifying this token. So save this token to updated the Flix in the future. To edit the queries use: http://localhost:1000/create?token=<saved token>. To edit the personalization use: http://localhost:1000/create/preview?token=<saved token>

3. Running the flix

   Finaly the new Flix will be available at http://localhost:1000/ using the name of the Flix specified in step 2.

Contributing

We welcome contributions! Please follow these steps to contribute:

Fork the repository.

1. Create a new branch:

   git checkout -b my-feature-branch
   

2. Make your changes.

3. Commit your changes:

   git commit -m "Add some feature"
   

4. Push to the branch:

   git push origin my-feature-branch
   

5. Create a pull request.