Updated README.md, few bug tweaks, adding regression_results.ipynb

README.md

@@ -1,30 +1,37 @@
 # 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.
-   ```bash
-   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:
-   ```text
-   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
+## 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**
    ```Bash
    git clone https://git.hanspayer.com/hpayer/museum_analytics.git
    ```
-3. Build and start the museum analytics server with docker:
+3. **Duplicate the template file:** 
+   Copy the `.env.example` file and rename it to `.env` in the root directory.
+   ```bash
+   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 the placeholder values with your actual credentials:
+   ```text
+   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:**
    ```Bash
-   cd ./api
-   docker build --network=host --no-cache -t museum-analytics-server .
+   # in the museum_analytics working directory
+   docker compose up --build
+   ```
+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**
+   ```Bash
+   docker compose down
    ```