Improve contributing experience

houby-studio · Oct 26, 2023 · ad7e60f · ad7e60f
1 parent 82538c3
commit ad7e60f
Show file tree

Hide file tree

Showing 6 changed files with 154 additions and 68 deletions.
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -11,7 +11,7 @@
       "skipFiles": [
         "<node_internals>/**"
       ],
-      "program": "${workspaceFolder}\\bin\\www",
+      "program": "${workspaceFolder}/bin/www",
       "outputCapture": "std"
     }
   ]

diff --git a/README.md b/README.md
@@ -5,13 +5,13 @@
 
 ## 2023 UPDATE
 
-This simple system is alive and kicking for 4 years already in our office! While imperfect, it has enabled us to share 4379 pieces of drinks and food in total cost of 76374 CZK as of today.  
+This simple system is alive and kicking for 4 years already in our office! While imperfect, it has enabled us to share 4379 pieces of drinks and food in total cost of 76374 CZK as of today.
 We actually keep expanding to other colleagues, adding more products and features. That has obviously shown certain weak points of this system and for that very reason we have dusted off our javascript skills to get this system back on track!
 You can expect fixes of many features, updating all dependencies, some most needed new features and who knows, maybe some magical ✨AI✨ add-ons?
 
 ## Disclaimer
 
-This tool is exclusively made by us and used by us, but we have commited anyways to make it FOSS and configurable to allow others to use it if they want!  
+This tool is exclusively made by us and used by us, but we have commited anyways to make it FOSS and configurable to allow others to use it if they want!
 There are however couple things that may need some customizations on your end, whether you fork it or open a pull request on this repository. The list of gotchas:
 
 - Authentication is written for Microsoft Entra ID (Azure Active Directory)
@@ -20,22 +20,22 @@ There are however couple things that may need some customizations on your end, w
 
 ## Super simple e-shop for colleagues
 
-**Small Business Fridge** offers simple, mostly intuitive e-shop which shows what products are available, how many and for how much.  
-Customers can buy product with one simple click. The only other thing they have to do is to take the product and consume it. They also receive simple e-mail notification.  
+**Small Business Fridge** offers simple, mostly intuitive e-shop which shows what products are available, how many and for how much.
+Customers can buy product with one simple click. The only other thing they have to do is to take the product and consume it. They also receive simple e-mail notification.
 This obviously comes with many other utilities such as:
 
- - page to display order history, total amount spent
- - page for supplier to add products to the stock
- - page for supplier to automatically create invoices (read QR code) for all customers and send it to their e-mail addresses
- - page to mark invoice as paid from both customer and supplier side
- - page for admin who can view all the standard pages across all the customers and suppliers
- - colorful graphs which are hopefully useful
+- page to display order history, total amount spent
+- page for supplier to add products to the stock
+- page for supplier to automatically create invoices (read QR code) for all customers and send it to their e-mail addresses
+- page to mark invoice as paid from both customer and supplier side
+- page for admin who can view all the standard pages across all the customers and suppliers
+- colorful graphs which are hopefully useful
 
-*But what if I do not want to launch browser to buy product even though it is super easy?*  
-No problem! You can either assign kiosk role to a user, which can be logged on a some thin client with browser next to a fridge, eventually with touch screen display to allow easy shopping right at the fridge,  
+*But what if I do not want to launch browser to buy product even though it is super easy?*
+No problem! You can either assign kiosk role to a user, which can be logged on a some thin client with browser next to a fridge, eventually with touch screen display to allow easy shopping right at the fridge,
 or there is API for anything you can and want to make! We have also worked and used for some time simple Arduino ESP32 device which may be found here [Small business fridge IoT keypad](https://github.com/houby-studio/small-business-fridge-keypad)
 
-The whole system is running on Node.js with Express.js framework and stores data in MongoDB. We have made everything in our power to secure this application by using Azure passport allowing you to use your company ID to login and manage everything.  
+The whole system is running on Node.js with Express.js framework and stores data in MongoDB. We have made everything in our power to secure this application by using Azure passport allowing you to use your company ID to login and manage everything.
 It should be pretty lightweight, as we run it on a potato without any problems for around 20 users.
 
 ## Want to know more?
@@ -45,13 +45,20 @@ Go checkout [Wiki](https://github.com/houby-studio/small-bussiness-fridge/wiki)
 ## Images
 
 ### E-Shop
-![Shop](https://raw.githubusercontent.com/wiki/houby-studio/small-bussiness-fridge/images/sbf_shop.png)  
+
+![Shop](https://raw.githubusercontent.com/wiki/houby-studio/small-bussiness-fridge/images/sbf_shop.png)
+
 ### Orders
-![image2](https://raw.githubusercontent.com/wiki/houby-studio/small-bussiness-fridge/images/sbf_orders.png)  
+
+![image2](https://raw.githubusercontent.com/wiki/houby-studio/small-bussiness-fridge/images/sbf_orders.png)
+
 ### Invoice
-![image3](https://raw.githubusercontent.com/wiki/houby-studio/small-bussiness-fridge/images/sbf_invoice.png)  
+
+![image3](https://raw.githubusercontent.com/wiki/houby-studio/small-bussiness-fridge/images/sbf_invoice.png)
+
 ### Deliver
-![image4](https://raw.githubusercontent.com/wiki/houby-studio/small-bussiness-fridge/images/sbf_deliver.png)  
+
+![image4](https://raw.githubusercontent.com/wiki/houby-studio/small-bussiness-fridge/images/sbf_deliver.png)
 
 ## License
 
@@ -70,7 +77,7 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
 One way
 
 - You can customize docker-compose.dev.example.yaml to develop with all required tools in containers
- - Not tested, we debug main application directly on our computer and use containers to run database and other dev tools
+- Not tested, we debug main application directly on our computer and use containers to run database and other dev tools
 
 Second way
 
@@ -82,3 +89,36 @@ Second way
 For linux users, you may want to allow node to bind to system protected ports
 
 `sudo setcap 'cap_net_bind_service=+ep' $(readlink -f $(which node))`
+
+### Manjaro
+
+Tested this setup 2023-10-26 with VSCode, Node.js 18 and Docker.
+Main app is being run directly on host, mongo, mongo express and maildev in docker compose.
+
+#### Installed packages
+
+- git
+- nodejs-lts-hydrogen
+- docker
+- docker-compose
+- yay
+  - visual-studio-code-bin
+
+### Setup development environment
+
+- Clone repo `git clone https://github.com/houby-studio/small-business-fridge.git`
+- Change into a directory and launch VSCode `cd small-business-fridge && code .`
+- For VSCode extensions we recommend at least Prettier (Native formatter does not like handlebars)
+- Install dependencies `npm install`
+- Prepare other containers for dev `cp docker-compose.dev.example.yaml docker-compose.dev.yaml`
+  - If you want to run main app in container as well, there is commented out section, which may be used with some tweaks
+- Prepare dotenv variables `cp dev.example.env .env` and at least change following variables with your AAD registered App:
+  - CREDS_IDENTITY_METADATA
+  - CREDS_CLIENT_ID
+  - CREDS_CLIENT_SECRET
+- Allow node to bind to port 443 `sudo setcap 'cap_net_bind_service=+ep' $(readlink -f $(which node))`
+- Hit F5 to start debugging
+- Navigate to <https://localhost/> and login with your AAD account - since you have **NODE_ENV=development**, all new users will be admins and suppliers by default
+- Add new products, deliveries, start buying, invoicing etc.
+- Navigate to <http://localhost:8080> to view all **e-mails** being sent
+- Navigate to <http://localhost:8081> with login admin:pass to view, edit, export and import data in database **sbf-dev**
diff --git a/defaults.env b/defaults.env
@@ -4,16 +4,16 @@ APP_PORT_SSL=443
 APP_RATE_LIMIT_PER_MIN=25
 APP_RATE_LIMIT_TRUSTED_IP=
 DB_CONNECTION_STRING=mongodb+srv://usr:[email protected]/sbf?retryWrites=true&w=majority
-COOKIE_SECRET=verysecretverysecretverysecretverysecretverysecretoh
-PARSER_SECRET=ohverysecretverysecretverysecretverysecretverysecret
+COOKIE_SECRET=
+PARSER_SECRET=
 API_SECRET=
 DEBUG=false
 MAIL_PORT=25
-MAIL_HOST=localhost
+MAIL_HOST={mailserver}
 MAIL_FROM=Small Business Fridge
-MAIL_USERNAME=[email protected]
-MAIL_PASSWORD=somerandompassword
-MAIL_SYSTEM=[email protected]
+MAIL_USERNAME=
+MAIL_PASSWORD=
+MAIL_SYSTEM=
 MAIL_DEV_SYSTEM=false
 TASKS_DAILY_REPORT_ENABLED=true
 TASKS_DAILY_REPORT_WEEK_START=1
@@ -25,22 +25,22 @@ TASKS_DAILY_BACKUP_ENABLED=true
 TASKS_DAILY_BACKUP_DAYS_TO_KEEP=14
 TASKS_DAILY_BACKUP_HOUR=23
 TASKS_DAILY_BACKUP_MINUTE=30
-CREDS_IDENTITY_METADATA=https://login.microsoftonline.com/tenant-id/v2.0/.well-known/openid-configuration
-CREDS_CLIENT_ID=some-client-id
+CREDS_IDENTITY_METADATA=https://login.microsoftonline.com/{tenant-id}/v2.0/.well-known/openid-configuration
+CREDS_CLIENT_ID={some-client-id}
+CREDS_CLIENT_SECRET={somegeneratedsecret}
 CREDS_RESPONSE_TYPE=id_token
 CREDS_RESPONSE_MODE=form_post
-CREDS_REDIRECT_URL=https://localhost/auth/openid/return
+CREDS_REDIRECT_URL=https://{sbfurl}/auth/openid/return
 CREDS_ALLOW_HTTP_FOR_REDIRECT_URL=false
-CREDS_CLIENT_SECRET=somegeneratedsecret
 CREDS_VALIDATE_ISSUER=true
 CREDS_ISB2C=
 CREDS_ISSUER=
 CREDS_PASS_REQ_TO_CALLBACK=false
 CREDS_LOGGING_LEVEL=
 CREDS_NONCE_MAX_AMOUNT=5
 CREDS_USE_COOKIE_INSTEAD_OF_SESSION=true
-CREDS_COOKIE_ENCRYPTION_KEY=thiskeyhastobethirtytwobyteslong
-CREDS_COOKIE_ENCRYPTION_VALUE=disbeshorter
+CREDS_COOKIE_ENCRYPTION_KEY=
+CREDS_COOKIE_ENCRYPTION_VALUE=
 CREDS_COOKIE_SAME_SITE=true
-CREDS_DESTROY_SESSION_URL=https://localhost/
+CREDS_DESTROY_SESSION_URL=https://{sbfurl}/
 TZ=Europe/Prague
diff --git a/dev.example.env b/dev.example.env
@@ -0,0 +1,47 @@
+NODE_ENV=development
+APP_PORT=3000
+APP_PORT_SSL=443
+APP_RATE_LIMIT_PER_MIN=25
+APP_RATE_LIMIT_TRUSTED_IP=127.0.0.1
+DB_CONNECTION_STRING=mongodb://sbf-app:password@localhost:27017/sbf-dev?retryWrites=true&w=majority&tls=false&directConnection=true&authSource=admin
+COOKIE_SECRET=verysecretverysecretverysecretverysecretverysecretoh
+PARSER_SECRET=ohverysecretverysecretverysecretverysecretverysecret
+API_SECRET=developmentsecret
+DEBUG=true
+MAIL_PORT=8025
+MAIL_HOST=localhost
+MAIL_FROM=[DEV] Small Business Fridge
+MAIL_USERNAME=[email protected]
+MAIL_PASSWORD=somerandompassword
+MAIL_SYSTEM=[email protected]
+MAIL_DEV_SYSTEM=false
+MAIL_CRON_BASE_URL=https://localhost
+TASKS_DAILY_REPORT_ENABLED=true
+TASKS_DAILY_REPORT_WEEK_START=1
+TASKS_DAILY_REPORT_WEEK_END=5
+TASKS_DAILY_REPORT_SEND_HOUR=16
+TASKS_DAILY_REPORT_SEND_MINUTE=30
+TASKS_WEEKLY_REPORT_ENABLED=true
+TASKS_DAILY_BACKUP_ENABLED=true
+TASKS_DAILY_BACKUP_DAYS_TO_KEEP=14
+TASKS_DAILY_BACKUP_HOUR=23
+TASKS_DAILY_BACKUP_MINUTE=30
+CREDS_IDENTITY_METADATA=https://login.microsoftonline.com/{tenant-id}/v2.0/.well-known/openid-configuration
+CREDS_CLIENT_ID={some-client-id}
+CREDS_CLIENT_SECRET={somegeneratedsecret}
+CREDS_RESPONSE_TYPE=id_token
+CREDS_RESPONSE_MODE=form_post
+CREDS_REDIRECT_URL=https://localhost/auth/openid/return
+CREDS_ALLOW_HTTP_FOR_REDIRECT_URL=false
+CREDS_VALIDATE_ISSUER=true
+CREDS_ISB2C=
+CREDS_ISSUER=
+CREDS_PASS_REQ_TO_CALLBACK=false
+CREDS_LOGGING_LEVEL=
+CREDS_NONCE_MAX_AMOUNT=5
+CREDS_USE_COOKIE_INSTEAD_OF_SESSION=true
+CREDS_COOKIE_ENCRYPTION_KEY=thiskeyhastobethirtytwobyteslong
+CREDS_COOKIE_ENCRYPTION_VALUE=disbeshorter
+CREDS_COOKIE_SAME_SITE=true
+CREDS_DESTROY_SESSION_URL=https://localhost/
+TZ=Europe/Prague
diff --git a/docker-compose.dev.example.yaml b/docker-compose.dev.example.yaml
@@ -1,35 +1,25 @@
 version: "3.8"
 services:
-  dev-small-business-fridge:
-    image: houbystudio/small-business-fridge:latest
-    container_name: dev-small-business-fridge
-    environment:
-      - NODE_ENV=development
-      - DB_CONNECTION_STRING=mongodb://sbf-app:password@dev-mongo:27017/sbf-dev?retryWrites=true&w=majority&tls=false&directConnection=true&authSource=admin
-      - COOKIE_SECRET=d73c6d69-7393-495f-8bec-6e60f7579eecd73c6d69-7393-49
-      - PARSER_SECRET=ffbbcb61-0000-4184-b7e2-bd5720cadc44ffbbcb61-0000-41
-      - API_SECRET=ffbbcb61-0000-4184-b7e2-
-      - MAIL_PORT=1025
-      - MAIL_HOST=dev-maildev
-      - MAIL_FROM=[DEV] Small Business Fridge
-      - [email protected]
-      - [email protected]
-      - MAIL_PASSWORD=
-      - CREDS_IDENTITY_METADATA=https://login.microsoftonline.com/{tenant}/v2.0/.well-known/openid-configuration
-      - CREDS_CLIENT_ID=26ea4641-db92-4cd4-a080-8027970bd7e5
-      - CREDS_REDIRECT_URL=https://sbf-dev.example.com/auth/openid/return
-      - CREDS_CLIENT_SECRET=26ea4641db924cd4a0808027970bd7e5
-      - CREDS_COOKIE_ENCRYPTION_KEY=926a06e9-a39c-48ef-a56a-0ed1dbbd
-      - CREDS_COOKIE_ENCRYPTION_VALUE=9be3b6ec2dc4
-      - CREDS_DESTROY_SESSION_URL=https://sbf-dev.example.com/
-      - TZ=Europe/Prague
-    ports:
-      - 3000:3000
-    volumes:
-      - dev-images:/usr/src/app/public/images
-      - dev-backup:/usr/src/app/database-backup
-      - dev-logs:/usr/src/app/logs
-    restart: unless-stopped
+  # dev-small-business-fridge:
+  #   image: houbystudio/small-business-fridge:latest
+  #   container_name: dev-small-business-fridge
+  #   environment:
+  #     - DB_CONNECTION_STRING=mongodb://sbf-app:password@dev-mongo:27017/sbf-dev?retryWrites=true&w=majority&tls=false&directConnection=true&authSource=admin
+  #     - API_SECRET=ffbbcb61-0000-4184-b7e2-
+  #     - MAIL_PORT=1025
+  #     - MAIL_HOST=dev-maildev
+  #     - CREDS_IDENTITY_METADATA=https://login.microsoftonline.com/{tenant}/v2.0/.well-known/openid-configuration
+  #     - CREDS_CLIENT_ID=26ea4641-db92-4cd4-a080-8027970bd7e5
+  #     - CREDS_CLIENT_SECRET=26ea4641db924cd4a0808027970bd7e5
+  #   ports:
+  #     - 3000:3000
+  #   volumes:
+  #     - dev-images:/usr/src/app/public/images
+  #     - dev-backup:/usr/src/app/database-backup
+  #     - dev-logs:/usr/src/app/logs
+  #   restart: unless-stopped
+  #    depends_on:
+  #      - dev-mongo
 
   dev-mongo:
     image: mongo
@@ -51,6 +41,8 @@ services:
       ME_CONFIG_MONGODB_ADMINUSERNAME: sbf-app
       ME_CONFIG_MONGODB_ADMINPASSWORD: password
       ME_CONFIG_MONGODB_URL: mongodb://sbf-app:password@dev-mongo:27017/
+    depends_on:
+      - dev-mongo
 
   dev-maildev:
     image: maildev/maildev
@@ -68,7 +60,7 @@ services:
         max-size: "1m"
 
 volumes:
-  dev-images:
-  dev-backup:
-  dev-database:
-  dev-logs:
+  # dev-images:
+  # dev-backup:
+  # dev-logs:
+  dev-database:
diff --git a/functions/azure-passport.js b/functions/azure-passport.js
@@ -113,12 +113,19 @@ passport.use(
                   )
                   return done(1)
                 }
+                console.log(process.env.NODE_ENV)
                 const newUser = new User()
                 newUser.oid = profile.oid
                 newUser.displayName = profile.displayName
                 newUser.email = profile._json.email
-                profile.admin = false
-                profile.supplier = false
+                newUser.admin =
+                  process.env.NODE_ENV.toLowerCase() === 'development'
+                    ? true
+                    : false
+                newUser.supplier =
+                  process.env.NODE_ENV.toLowerCase() === 'development'
+                    ? true
+                    : false
                 // Async function to find highest keypad ID and increment it by one.
                 const latestUser = function (callback) {
                   User.find()