Museum Analytics

Installation and how to use

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. Duplicate the template file: Copy the .env.example file and rename it to .env in the root directory.

   cd museum_analytics
   cp ./api/app/.env.example ./api/app/.env
   

4. Modify .env Open the newly created .env file in your text editor and replace "your_email_address" values with your actual email address:

   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.

5. Build and start the museum analytics and jupyter notebook servers with docker compose:

   # in the museum_analytics working directory
   docker compose up --build -d
   

6. Open the http://127.0.0.1:8888/ in your browser to access jupyter notebook.

7. Open the regression_results.ipynb file and Run the code in jupyter notebook.

8. To shutdown the servers, run this command in the terminal

   docker compose down