feat: Added config.js script for easier secret handling

Author: MicLieg

.gitignore

@@ -0,0 +1,2 @@
+# Ignore ./js/config.js file
+js/config.js

README.md

@@ -57,17 +57,18 @@ Automatically logs:
 To set up the project, follow these steps:
 
 1. Clone the repository.
-2. Create a new Google Sheet.
-3. Insert the following headers in the first row: `Date`, `Start time`, `End time`, `Gross working time`, `Break time`, `Net working time`, `Difference target / actual`.
-4. In cell `H:1`, insert the calculation of your time credit: `=SUM(G:G;G1)`.
-5. Delete all empty rows.
-6. In Google Sheet, go to `Extensions` -> `Apps Script`.
-7. Paste the contents of `./js/apps_script.js` into the editor.
-8. In the Apps Script Editor, update the `SPREADSHEET_ID` variable with the ID of your Google Sheet (part of the URL).
-9. Deploy the script as a web app by clicking the `Deploy` button and selecting `New deployment`.
-10. Copy the URL of the web application and update the `APPS_SCRIPT_URL` variable in `./js/script.js` with this URL.
-11. (Optional) Customize the `PLANNED_WORK_DAY_HOURS`, `FIRST_BREAK_THRESHOLD_HOURS`, `FIRST_BREAK_MINUTES`, `SECOND_BREAK_THRESHOLD_HOURS` and `SECOND_BREAK_MINUTES` variables in `./js/script.js` to fit your needs.
-12. (Optional) Copy the files (except `./screenshots/` and `README.md`) to a web server of your choice.
-13. Visit the web server's URL in your browser OR open the `index.html` file in your browser.
-14. Start tracking your working hours by clicking the `Start` button. A new row will be added to your Google Sheet with the current date and time.
-15. Click the `Stop` button to stop tracking your working hours. The end time will be added to the row in your Google Sheet.
+2. Copy `./js/config.template.js` to `./js/config.js`
+3. Create a new Google Sheet.
+4. Insert the following headers in the first row: `Date`, `Start time`, `End time`, `Gross working time`, `Break time`, `Net working time`, `Difference target / actual`.
+5. In cell `H:1`, insert the calculation of your time credit: `=SUM(G:G;G1)`.
+6. Delete all empty rows.
+7. In Google Sheet, go to `Extensions` -> `Apps Script`.
+8. Paste the contents of `./js/apps_script.js` into the editor.
+9. In the Apps Script Editor, update the `SPREADSHEET_ID` variable with the ID of your Google Sheet (part of the URL).
+10. Deploy the script as a web app by clicking the `Deploy` button and selecting `New deployment`.
+11. Copy the URL of the web application and update the `APPS_SCRIPT_URL` in `./js/config.js` with your URL.
+12. (Optional) Customize the `PLANNED_WORK_DAY_HOURS`, `FIRST_BREAK_THRESHOLD_HOURS`, `FIRST_BREAK_MINUTES`, `SECOND_BREAK_THRESHOLD_HOURS` and `SECOND_BREAK_MINUTES` variables in `./js/config.js` to fit your needs.
+13. (Optional) Copy the files (except `./screenshots/` and `README.md`) to a (static) web server of your choice.
+14. Visit the web server's URL in your browser OR open the `index.html` file directly in your browser.
+15. Start tracking your working hours by clicking the `Start` button. A new row will be added to your Google Sheet with the current date and time.
+16. Click the `Stop` button to stop tracking your working hours. The end time will be added to the row in your Google Sheet.

index.html

@@ -22,6 +22,8 @@ <h1>Time Tracker</h1>
             <p id="overtimeLabel">Overtime: <span id="overtime">00:00:00</span></p>
         </div>
     </div>
+
+    <script src="./js/config.js"></script>
     <script src="./js/script.js"></script>
 </body>
 

js/apps_script.js

@@ -1,5 +1,5 @@
 function doPost(e) {
-  const SPREADSHEET_ID = 'GOOGLE_SPREADSHEET_ID';
+  const SPREADSHEET_ID = 'YOUR_GOOGLE_SPREADSHEET_ID';
   const spreadsheet = SpreadsheetApp.openById(SPREADSHEET_ID);
   const currentYear = new Date().getFullYear();
   const sheetName = currentYear.toString();

js/config.template.js

@@ -0,0 +1,35 @@
+/**
+ * URL for the Google Apps Script endpoint
+ * @constant {string}
+ */
+export const APPS_SCRIPT_URL = 'YOUR_APPS_SCRIPT_URL';
+
+/**
+ * Number of hours in a planned work day
+ * @constant {number}
+ */
+export const PLANNED_WORK_DAY_HOURS = 8;
+
+/**
+ * Hour threshold when first break becomes mandatory
+ * @constant {number}
+ */
+export const FIRST_BREAK_THRESHOLD_HOURS = 6;
+
+/**
+ * Duration of first mandatory break in minutes
+ * @constant {number}
+ */
+export const FIRST_BREAK_MINUTES = 30;
+
+/**
+ * Hour threshold when second break becomes mandatory
+ * @constant {number}
+ */
+export const SECOND_BREAK_THRESHOLD_HOURS = 9;
+
+/**
+ * Duration of second mandatory break in minutes
+ * @constant {number}
+ */
+export const SECOND_BREAK_MINUTES = 15;

js/script.js

@@ -1,39 +1,3 @@
-/**
- * URL for the Google Apps Script endpoint
- * @constant {string}
- */
-const APPS_SCRIPT_URL = 'APPS_SCRIPT_URL';
-
-/**
- * Number of hours in a planned work day
- * @constant {number}
- */
-const PLANNED_WORK_DAY_HOURS = 8;
-
-/**
- * Hour threshold when first break becomes mandatory
- * @constant {number}
- */
-const FIRST_BREAK_THRESHOLD_HOURS = 6;
-
-/**
- * Duration of first mandatory break in minutes
- * @constant {number}
- */
-const FIRST_BREAK_MINUTES = 30;
-
-/**
- * Hour threshold when second break becomes mandatory
- * @constant {number}
- */
-const SECOND_BREAK_THRESHOLD_HOURS = 9;
-
-/**
- * Duration of second mandatory break in minutes
- * @constant {number}
- */
-const SECOND_BREAK_MINUTES = 15;
-
 /**
  * State variables for tracking time and intervals
  * @type {Date} startTime - Work start timestamp
@@ -47,10 +11,22 @@ let startTime, stopTime, countdownInterval, overtimeInterval;
  * Initialize app when DOM content is loaded
  */
 document.addEventListener('DOMContentLoaded', () => {
+    checkAppsScriptUrl();
     loadStoredTimes();
     addEventListeners();
 });
 
+/**
+ * Check if APPS_SCRIPT_URL has been changed from default value
+ * @throws {Error} If URL has not been changed from default
+ */
+function checkAppsScriptUrl() {
+    if (APPS_SCRIPT_URL === 'YOUR_APPS_SCRIPT_URL') {
+        alert('Please update the APPS_SCRIPT_URL constant with your Google Apps Script deployment URL');
+        console.error('APPS_SCRIPT_URL not configured');
+    }
+}
+
 /**
  * Load and process stored start/stop times from localStorage
  */