Merge pull request #102 from open-template-hub/develop

Release/update docs

README.md

@@ -17,7 +17,7 @@ Open Template Hub - Auth Server Template v2
 [![Postman](https://img.shields.io/badge/Postman-Test%20Results-FF6C37?style=for-the-badge&logo=postman)](https://github.com/open-template-hub/auth-server-template/blob/develop/assets/test-results/postman.html)
 [![BTC](https://img.shields.io/badge/Donate-BTC-ORANGE?color=F5922F&style=for-the-badge&logo=bitcoin)](https://commerce.coinbase.com/checkout/8313af5f-de48-498d-b2cb-d98819ca7d5e)
 
-Authentication Server Template supporting both regular signup and login processes and login with social networks that support OAuth and OAuth2.0
+Auth Server Template is an open source authentication server that has simple and generic design to connect your authentication system with every OAuth 2.0 and OAuth supporting third party companies like Google, Facebook, Twitter or LinkedIn. We are also supporting regular username password authentication system
 
 ## Ways to Begin
 
@@ -94,11 +94,11 @@ RESPONSE_ENCRYPTION_SECRET={Response Encryption Secret}
 
 ## Social Login Configurations
 
-To be able to use social login mechanism, refer to **[SOCIAL_LOGIN.md](SOCIAL_LOGIN.md)** file.
+To be able to use social login mechanism, refer to **[SOCIAL_LOGIN.md](docs/SOCIAL_LOGIN.md)** file.
 
 ## Regression Tests
 
-To be able to run regression tests, refer to **[REGRESSION_TESTS.md](REGRESSION_TESTS.md)** file.
+To be able to run regression tests, refer to **[REGRESSION_TESTS.md](docs/REGRESSION_TESTS.md)** file.
 
 ## Http Requests
 
@@ -123,11 +123,15 @@ You can find list of available http request in the [requests](assets/requests) d
 
 ## Contributing
 
-* Fork it
-* Create your update branch (git checkout -b my-feature-branch)
-* Commit your changes (git commit -am 'Add some features')
-* Push to the branch (git push origin my-feature-branch)
-* Create new Pull Request
+Refer to **[CONTRIBUTING.md](https://github.com/open-template-hub/.github/blob/master/docs/CONTRIBUTING.md)** to see how to contribute to Open Template Hub.
+
+<br/>
+
+## Code of Conduct
+
+Refer to **[CODE_OF_CONDUCT.md](https://github.com/open-template-hub/.github/blob/master/docs/CODE_OF_CONDUCT.md)** to see contributor covenant code of conduct.
+
+<br/>
 
 ## LICENSE
 

dependency-checker.ts

@@ -0,0 +1,56 @@
+const { spawnSync } = require( 'child_process' );
+const outdatedCmd = spawnSync( 'npm', [ 'outdated' ] );
+
+const lines = outdatedCmd.stdout.toString().split( '\n' );
+
+const columnIndexes = [ 0, 0, 0, 0 ];
+
+console.log(
+    '<p align="center">\n' +
+    '  <a href="https://opentemplatehub.com">\n' +
+    '    <img src="https://raw.githubusercontent.com/open-template-hub/open-template-hub.github.io/master/assets/logo/server/auth-server-logo.png" alt="Logo" width=200>\n' +
+    '  </a>\n' +
+    '</p>\n' +
+    '\n' +
+    '\n' +
+    '<h1 align="center">\n' +
+    'Open Template Hub - Auth Server Template v2\n' +
+    '  <br/>\n' +
+    '(outdated packages)\n' +
+    '</h1>\n' +
+    '\n' +
+    'Following packages are not updated in the develop branch yet. So, if you want to update outdated packages on your own risk, update the package.json and install dependencies.\n'
+);
+
+for ( const line of lines ) {
+  if ( line.length === 0 ) {
+    continue;
+  }
+
+  if ( lines.indexOf( line ) === 0 ) {
+    columnIndexes[ 0 ] = line.indexOf( 'Current' );
+    columnIndexes[ 1 ] = line.indexOf( 'Wanted' ) + 3;
+    columnIndexes[ 2 ] = line.indexOf( 'Latest' ) + 6;
+    columnIndexes[ 3 ] = line.indexOf( 'Location' ) + 9;
+  }
+
+  let modifiedLine = line;
+
+  if ( columnIndexes [ 0 ] >= 0 ) {
+    for ( const columnIndex of columnIndexes ) {
+      modifiedLine = modifiedLine.substring( 0, columnIndex ) + ' | ' + modifiedLine.substring( columnIndex, modifiedLine.length );
+    }
+    console.log( '| ' + modifiedLine + ' |' );
+  } else {
+    console.log( modifiedLine );
+  }
+
+  if ( lines.indexOf( line ) === 0 ) {
+    console.log( '| --- | --- | --- | --- | --- |' );
+  }
+}
+
+console.log(
+    '\n' +
+    '<table align="right"><tr><td><a href="https://opentemplatehub.com"><img src="https://raw.githubusercontent.com/open-template-hub/open-template-hub.github.io/master/assets/logo/brand-logo.png" width="50px" alt="oth"/></a></td><td><b>Open Template Hub © 2021</b></td></tr></table>\n'
+);

docs/OUTDATED.md

@@ -0,0 +1,19 @@
+<p align="center">
+   <a href="https://opentemplatehub.com">
+    <img src="https://raw.githubusercontent.com/open-template-hub/open-template-hub.github.io/master/assets/logo/server/auth-server-logo.png" alt="Logo" width=200>
+  </a>
+</p>
+
+<h1 align="center">
+Open Template Hub - Auth Server Template v2
+  <br/>
+(outdated packages)
+</h1>
+
+Following packages are not updated in the develop branch yet. So, if you want to update outdated packages on your own risk, update the package.json and install dependencies.
+
+| Package      | Current   | Wanted   | Latest   | Location |
+| --- | --- | --- | --- | --- |
+
+<table align="right"><tr><td><a href="https://opentemplatehub.com"><img src="https://raw.githubusercontent.com/open-template-hub/open-template-hub.github.io/master/assets/logo/brand-logo.png" width="50px" alt="oth"/></a></td><td><b>Open Template Hub © 2021</b></td></tr></table>
+

package.json

@@ -1,14 +1,15 @@
 {
   "name": "auth-server-template",
-  "description": "Authentication Server Template supporting both regular signup and login processes and login with social networks that support OAuth and OAuth2.0",
+  "description": "Auth Server Template is an open source authentication server that has simple and generic design to connect your authentication system with every OAuth 2.0 and OAuth supporting third party companies like Google, Facebook, Twitter or LinkedIn. We are also supporting regular username password authentication system",
   "version": "3.0.0",
   "license": "MIT",
   "main": "auth-server.main.ts",
   "scripts": {
     "start": "node version-generator.ts > ./version.ts && ts-node auth-server.main.ts",
     "startLocal": "nodemon --exec DEBUG=* ts-node auth-server.main.ts",
     "postmanLocal": "mkdir -p -- ./assets/test-results && touch ./assets/test-results/postman-dark.html && touch ./assets/test-results/postman.html && newman run assets/tests/regression-tests/postman/regression-test.postman_collection.json -e assets/tests/regression-tests/postman/regression-test.postman_environment_local.json -r htmlextra --reporter-htmlextra-export ./assets/test-results/postman.html --reporter-htmlextra-darkTheme  > ./assets/test-results/postman-dark.html --env-var $npm_config_adminAuthToken --env-var $npm_config_responseEncryptionSecret",
-    "postmanDevelop": "mkdir -p -- ./assets/test-results && touch ./assets/test-results/postman-dark.html && touch ./assets/test-results/postman.html && newman run assets/tests/regression-tests/postman/regression-test.postman_collection.json -e assets/tests/regression-tests/postman/regression-test.postman_environment_develop.json -r htmlextra --reporter-htmlextra-export ./assets/test-results/postman.html --reporter-htmlextra-darkTheme  > ./assets/test-results/postman-dark.html --env-var $npm_config_adminAuthToken --env-var $npm_config_responseEncryptionSecret"
+    "postmanDevelop": "mkdir -p -- ./assets/test-results && touch ./assets/test-results/postman-dark.html && touch ./assets/test-results/postman.html && newman run assets/tests/regression-tests/postman/regression-test.postman_collection.json -e assets/tests/regression-tests/postman/regression-test.postman_environment_develop.json -r htmlextra --reporter-htmlextra-export ./assets/test-results/postman.html --reporter-htmlextra-darkTheme  > ./assets/test-results/postman-dark.html --env-var $npm_config_adminAuthToken --env-var $npm_config_responseEncryptionSecret",
+    "outdated": "node dependency-checker.ts > docs/OUTDATED.md"
   },
   "dependencies": {
     "@open-template-hub/common": "^2.1.15",