museum_analytics/README.md

Museum Analytics

⚙️ Configuration Setup

This project uses environment variables to secure sensitive information. Follow these steps to configure your local environment:

1. Duplicate the template file: Copy the .env.example file and rename it to .env in the root directory.

   cp .env.example .env
   

2. Update your keys: Open the newly created .env file in your text editor and replace the placeholder values with your actual credentials:

   WIKIPEDIA_USER_AGENT="MuseumAnalytics/0.1 (your_email_address)"
   

⚠️ Important: Never commit your .env file to Git. It is already added to .gitignore to protect your secrets.

Installation

1. Make sure docker is installed: see https://docs.docker.com/get-started/get-docker/ for instructions.
2. Clone the repo

   git clone https://git.hanspayer.com/hpayer/museum_analytics.git
   

3. Build and start the museum analytics server with docker:

   cd ./api
   docker build --network=host --no-cache -t museum-analytics-server .