Merge pull request #1 from tberey/development

Merge dev-3.0.1 into main

.env.sample

@@ -2,6 +2,8 @@ APP_NAME = <app-name>
 PORT = 3000
 HOSTNAME = 127.0.0.1
 
+SESSION_SECRET = <secret>
+
 DB_HOST = <host>
 DB_USER = <username>
 DB_PASSWORD = <password>

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,85 @@
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ development, main ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ main ]
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'javascript' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
+        # Learn more:
+        # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v1
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1
+
+  test:
+    name: Install, Build & Test (Node ${{ matrix.node_version }} & ubuntu-latest)
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node_version: ['15.x'] #['15','14']
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    - name: Use Node.js ${{ matrix.node_version }}
+      uses: actions/setup-node@v1
+      with:
+        node-version: ${{ matrix.node_version }}
+
+    - name: install > build > clean
+      run: |
+        npm install
+        npm run build  --if-present
+        npm run cleanup --if-present
+
+    - name: update > install > build > test > clean
+      run: |
+        npm update
+        npm install
+        npm run build --if-present
+        npm run lint --if-present
+        npm run test:api --if-present

README.md

@@ -80,7 +80,7 @@ A Chatroom Application with User Authentication & Accounts. Login & Register to
 * [Typescript](https://www.typescriptlang.org/)
 * [NodeJS](https://nodejs.org/en/)
 * [Scoket.io](https://socket.io/)
-* [ExpressJS](https://expressjs.com/)
+* [Express](https://expressjs.com/)
 * [MySQL](https://www.mysql.com/)
 * [EJS](https://ejs.co/)
 * [Rollbar](https://rollbar.com/)
@@ -134,8 +134,14 @@ For help or guidance in downloading and running the application, see the followi
 <br>
 
 ### Screenshots
-Shot#1<br>
-![Screenshot#1](https://github.com/tberey/ts-node-chatroom/blob/development/screenshots/shot1.png?raw=true)
+Chatroom (Logged-in):<br>
+![Screenshot#1](https://github.com/tberey/ts-node-chatroom/blob/development/screenshots/chatroom-logged-in.png?raw=true)<br><br>
+
+Landing Page (Register and/or Login):<br>
+![Screenshot#1](https://github.com/tberey/ts-node-chatroom/blob/development/screenshots/landing-page.png?raw=true)<br><br>
+
+Multiple Users (All Logged-in):<br>
+![Screenshot#1](https://github.com/tberey/ts-node-chatroom/blob/development/screenshots/chatroom-multiple-users.png?raw=true)
 
 <br><hr><br>
 
@@ -149,6 +155,7 @@ Below is the refined and confirmed roadmap, that has been planned for completion
 |:---|:---|:---|:---|
 | <i>Bug#1</i> | <i>Bug details...</i> | <i>0.0.1</i> | <i>example#1</i> |
 | <i>Feature#4</i> | <i>Feature details...</i> |   | <i>example#2</i> |
+| Automatic Database Startup & Configuration | Auto-build database and table(s), and auto-populate data or test account (seeding). | | |
 
 <br><hr><br>
 
@@ -179,6 +186,7 @@ Below is the refined and confirmed roadmap, that has been planned for completion
 |Version 2.2.0 | [2020-05-20] | <ul><li>Final EJS Update & Cleanup</li><li>Further client-side Scripting restructure & tidy-up.</li><li>CSS stylesheets consolidation (2=>1).</li><li>Comments rewriting and tidy.</li><li>Final checkovers and tidy up + Testing.</li><li>Update README.md</li></ul>|
 |Version 2.2.0 | [2020-05-20] | <ul><li>Renaming and descriptions editing.</li><li>Update README.md</li></ul>|
 |Version 3.0.0 | [2021-07-29] | <ul><li>Project-wide update, reformat and clean-up, including modules.</li><li>Update README.md</li></ul>|
+|Version 3.0.1 | [2021-07-31] | <ul><li>Updates to session management implementation, plus a new interface.</li><li>Updates to database interactivity and infrastructure, creating new seperate class.</li><li>Update README.md</li></ul>|
 
 <br><hr><br>