Merge pull request #509 from ocademy-ai/main

merge

.github/workflows/awesome-main.yml

@@ -0,0 +1,52 @@
+name: awesome-main
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'awesome/database/data.db'
+
+jobs:
+  compare-dbs:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v2
+
+    - name: Set up SQLite
+      run: sudo apt-get install sqlite3
+
+    - name: Install sqldiff tool
+      run: |
+        wget https://www.sqlite.org/2023/sqlite-tools-linux-x86-3420000.zip
+        unzip sqlite-tools-linux-x86-3420000.zip
+
+    - name: Get target branch database
+      run: |
+        wget -O target_data.db https://raw.githubusercontent.com/${{ github.repository }}/main/awesome/database/data.db
+      
+    - name: Show database differences
+      run: ./sqlite-tools-linux-x86-3420000/sqldiff --primarykey target_data.db awesome/database/data.db
+
+    - name: Install dependencies
+      run: |
+        cd awesome
+        npm install
+
+    - name: Synchronize local and cloud databases
+      run: |
+        cd awesome/sync
+        export EMAIL=${{ secrets.EMAIL }}
+        export PASSWORD=${{ secrets.PASSWORD }}
+        export AWS_APPSYNC_AUTHENTICATIONTYPE=${{ secrets.AWS_APPSYNC_AUTHENTICATIONTYPE_TEST }}
+        export AWS_APPSYNC_GRAPHQLENDPOINT=${{ secrets.AWS_APPSYNC_GRAPHQLENDPOINT_TEST }}
+        export AWS_APPSYNC_REGION=${{ secrets.AWS_APPSYNC_REGION_TEST }}
+        export AWS_COGNITO_IDENTITY_POOL_ID=${{ secrets.AWS_COGNITO_IDENTITY_POOL_ID_TEST }}
+        export AWS_COGNITO_REGION=${{ secrets.AWS_COGNITO_REGION_TEST }}
+        export AWS_COGNITO_SIGNUP_ATTRIBUTES=${{ secrets.AWS_COGNITO_SIGNUP_ATTRIBUTES_TEST }}
+        export AWS_PROJECT_REGION=${{ secrets.AWS_PROJECT_REGION_TEST }}
+        export AWS_USER_POOLS_ID=${{ secrets.AWS_USER_POOLS_ID_TEST }}
+        export AWS_USER_POOLS_WEB_CLIENT_ID=${{ secrets.AWS_USER_POOLS_WEB_CLIENT_ID_TEST }}
+        node index.js

.github/workflows/awesome-release.yml

@@ -0,0 +1,52 @@
+name: awesome-release
+
+on:
+  push:
+    branches:
+      - release
+    paths:
+      - 'awesome/database/data.db'
+
+jobs:
+  compare-dbs:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v2
+
+    - name: Set up SQLite
+      run: sudo apt-get install sqlite3
+
+    - name: Install sqldiff tool
+      run: |
+        wget https://www.sqlite.org/2023/sqlite-tools-linux-x86-3420000.zip
+        unzip sqlite-tools-linux-x86-3420000.zip
+
+    - name: Get target branch database
+      run: |
+        wget -O target_data.db https://raw.githubusercontent.com/${{ github.repository }}/release/awesome/database/data.db
+
+    - name: Show database differences
+      run: ./sqlite-tools-linux-x86-3420000/sqldiff --primarykey target_data.db awesome/database/data.db
+
+    - name: Install dependencies
+      run: |
+        cd awesome
+        npm install
+
+    - name: Synchronize local and cloud databases
+      run: |
+        cd awesome/sync
+        export EMAIL=${{ secrets.EMAIL }}
+        export PASSWORD=${{ secrets.PASSWORD }}
+        export AWS_APPSYNC_AUTHENTICATIONTYPE=${{ secrets.AWS_APPSYNC_AUTHENTICATIONTYPE_PROD }}
+        export AWS_APPSYNC_GRAPHQLENDPOINT=${{ secrets.AWS_APPSYNC_GRAPHQLENDPOINT_PROD }}
+        export AWS_APPSYNC_REGION=${{ secrets.AWS_APPSYNC_REGION_PROD }}
+        export AWS_COGNITO_IDENTITY_POOL_ID=${{ secrets.AWS_COGNITO_IDENTITY_POOL_ID_PROD }}
+        export AWS_COGNITO_REGION=${{ secrets.AWS_COGNITO_REGION_PROD }}
+        export AWS_COGNITO_SIGNUP_ATTRIBUTES=${{ secrets.AWS_COGNITO_SIGNUP_ATTRIBUTES_PROD }}
+        export AWS_PROJECT_REGION=${{ secrets.AWS_PROJECT_REGION_PROD }}
+        export AWS_USER_POOLS_ID=${{ secrets.AWS_USER_POOLS_ID_PROD }}
+        export AWS_USER_POOLS_WEB_CLIENT_ID=${{ secrets.AWS_USER_POOLS_WEB_CLIENT_ID_PROD }}
+        node index.js

.github/workflows/pr-awesome-main.yml

@@ -0,0 +1,31 @@
+name: pr-awesome-main
+
+on:
+  pull_request:
+    branches:
+      - main
+    paths:
+      - 'awesome/database/data.db'
+
+jobs:
+  compare-dbs:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v2
+
+    - name: Set up SQLite
+      run: sudo apt-get install sqlite3
+
+    - name: Install sqldiff tool
+      run: |
+        wget https://www.sqlite.org/2023/sqlite-tools-linux-x86-3420000.zip
+        unzip sqlite-tools-linux-x86-3420000.zip
+
+    - name: Get target branch database
+      run: |
+        wget -O target_data.db https://raw.githubusercontent.com/${{ github.repository }}/main/awesome/database/data.db
+      
+    - name: Show database differences
+      run: ./sqlite-tools-linux-x86-3420000/sqldiff --primarykey target_data.db awesome/database/data.db

.github/workflows/pr-awesome-release.yml

@@ -0,0 +1,31 @@
+name: pr-awesome-release
+
+on:
+  pull_request:
+    branches:
+      - release
+    paths:
+      - 'awesome/database/data.db'
+
+jobs:
+  compare-dbs:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v2
+
+    - name: Set up SQLite
+      run: sudo apt-get install sqlite3
+
+    - name: Install sqldiff tool
+      run: |
+        wget https://www.sqlite.org/2023/sqlite-tools-linux-x86-3420000.zip
+        unzip sqlite-tools-linux-x86-3420000.zip
+
+    - name: Get target branch database
+      run: |
+        wget -O target_data.db https://raw.githubusercontent.com/${{ github.repository }}/release/awesome/database/data.db
+
+    - name: Show database differences
+      run: ./sqlite-tools-linux-x86-3420000/sqldiff --primarykey target_data.db awesome/database/data.db

.gitignore

@@ -23,4 +23,5 @@ open-machine-learning-jupyter-book/assignments/prerequisites/*
 */tmp/**
 */**/node_modules/*
 */node_modules/*
-awesome/database/node_modules
+awesome/node_modules
+awesome/sync/.config.development.json

CNAME

@@ -0,0 +1 @@
+press.ocademy.cc

CONTRIBUTING.md

@@ -8,7 +8,7 @@ Please read through this document before you submit any pull requests or issues.
 
 When you submit a pull request, our team is notified and will respond as quickly as we can. We'll do our best to work with you to ensure that your pull request adheres to our style and standards. If we merge your pull request, we might make additional edits later for style or clarity.
 
-The source files on GitHub aren't published directly to the official website. If we merge your pull request, we'll publish your changes to the staging website as soon as we can, but they won't appear immediately or automatically.
+The source files on GitHub aren't published directly on the official website. If we merge your pull request, we'll publish your changes to the staging website as soon as we can, but they won't appear immediately or automatically.
 
 We look forward to receiving your pull requests for:
 
@@ -22,13 +22,118 @@ We look forward to receiving your pull requests for:
 
 ## How to contribute
 
-- [Guidelines for contributing to awesome lists](./CONTRIBUTING-AWESOME-LIST.md)
-- [Guidelines for contributing to the open Machine Learning book](./CONTRIBUTING-OPEN-ML-BOOK.md)
+<details>
+<summary><b>Start by cloning the repo and fork to your local machine.</b></summary>
+
+```bash
+git clone https://github.com/<UserName>/machine-learning.git
+```
+
+> **Warning**
+>
+> You may see below errors that prevent you from connecting to the remote repository, or timeout errors when you do push operations, especially if you are using the HTTP protocol.
+>
+> ```bash
+> Permission denied (publickey).
+> fatal: Could not read from remote repository.
+> fatal: unable to access 'https://github.com/<UserName>/machine-learning.git/': Recv failure: Connection was reset.
+> fatal: unable to access 'https://github.com/<UserName>/machine-learning.git/': The requested URL returned error : 403.
+> ```
+>
+> Solution:
+>
+> 1. Use [SSH protocol](https://docs.github.com/en/authentication/connecting-to-github-with-ssh) to access the repo if you face network issue.
+> 2. Try more times in case the push operation fails occasionally.
+
+</details>
+
+Then, please follow the below guidance based on your needs.
+
+- [Guidelines for contributing to awesome lists](./awesome/CONTRIBUTING.md)
+- [Guidelines for contributing to the open Machine Learning book](./open-machine-learning-jupyter-book/CONTRIBUTING.md)
 
 ## Code of conduct
 
-See the [code of conduct](https://github.com/ocademy-ai/machine-learning/blob/main/CODE_OF_CONDUCT.md) for more information.
+See the [code of conduct](./CODE_OF_CONDUCT.md) for more information.
 
 ## Licensing
 
-See the LICENSE files([code](https://github.com/ocademy-ai/machine-learning/blob/master/LICENSE-CODE), [text](https://github.com/ocademy-ai/machine-learning/blob/master/LICENSE-TEXT)) for this project's licensing. We will ask you to confirm the licensing of your contribution. We may ask you to sign a [Contributor License Agreement (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement) for larger changes.
+See the LICENSE files([code](./LICENSE-CODE), [text](./LICENSE-TEXT)) for this project's licensing. We will ask you to confirm the licensing of your contribution. We may ask you to sign a [Contributor License Agreement (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement) for larger changes.
+
+## FAQ
+
+### How to configure ssh public and private keys?
+
+Follow the [ Atlassian Git SSH](https://www.atlassian.com/git/tutorials/git-ssh) official guidance to learn about Git and SSH.
+Then open GitHub, go to the configuration page, select SSH and GPG keys, select New SSH key, then use the text tool to open the id_rsa.pub file that was generated earlier, copy the contents to the input box below the key, define a name for the key, and save it.
+
+To change all of your local protocols to SSH, you can do the following:
+
+> 1. Open the command line terminal and go to the directory in your local repository.
+> 
+> 2. Enter the following command to view the current remote repository address:
+>
+> ```bash
+> git remote -v
+> ```
+>
+> The output should look something like:
+>
+> ```bash
+> origin  http://github.com/<username>/<repository>.git (fetch)
+> origin  http://github.com/<username>/<repository>.git (push)
+> ```
+> 
+> 3. copy the SSH URL from GitHub (format:[email protected]:<username>/<repository>.git)
+>
+> 4. Enter the following command to change the URL of the remote repository to the SSH URL:
+> 
+> ```bash
+> git remote set-url origin [email protected]:<username>/<repository>.git
+> ```
+>
+> 5. Updated upstream remote repository link:
+> 
+> ```bash
+> git remote set-url upstream [email protected]:ocademy-ai/machine-learning.git
+> ```
+> 
+> **Warning**
+> You may encounter following problem when you configure SSH.
+>
+> ```bash
+> HP@DESKTOP-H1SBMME MINGW64 ~/.ssh
+> $ ~/.ssh/config
+> bash: /c/Users/HP/.ssh/config: No such file or directory
+> ```
+> 
+> Solution:
+>
+> 1. To create the file using the Git Bash terminal, you can use the following command to create an empty SSH config file in your home directory:
+> 
+> ```bash
+> touch ~/.ssh/config
+> ```
+>
+> 2. add the following to SSH config file
+>
+> ```bash
+> Host github.com
+> HostName github.com
+> User git
+> IdentityFile ~/.ssh/id_rsa
+> ```
+>
+> **Warning**
+> You may encounter following problem when you use git push.
+>
+> ```bash
+> ssh: connect to host github.com port 22: Connection refused
+> fatal: Could not read from remote repository.
+> Please make sure you have the correct access rights
+> and the repository exists.
+> ```
+>
+> Solution:
+> 
+> Make sure you configured SSH correctly