diff --git a/.vscode/settings.json b/.vscode/settings.json index 242d20c7..c7d77f3e 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -3,5 +3,6 @@ "editor.formatOnSave": true, "githubPullRequests.ignoredPullRequestBranches": [ "develop" - ] + ], + "DockerRun.DisableDockerrc": true } diff --git a/utilities/1--GitHub-Overview b/utilities/1--GitHub-Overview new file mode 100644 index 00000000..1dbbf3ac --- /dev/null +++ b/utilities/1--GitHub-Overview @@ -0,0 +1,26 @@ +. +├── Dockerfile <-- Dockerfile defining container for local dev and deploy +├── README.md +├── _phlask.code-workspace +├── assets +├── contributing.md +├── cypress <-- Unit tests +│ ├── fixtures <-- Fixtures for mocked out data +│ └── integration <-- Source files for unit tests +├── cypress.json +├── docker-compose.yml +├── package-lock.json +├── package.json +├── public +├── src <-- Source files for project +│ ├── App.js +│ ├── actions <-- Source for all Redux actions +│ ├── components <-- Source for all React components +│ ├── firebase <-- Source for configurations used to connect to Firebase database +│ ├── helpers <-- Helper functions shared across components/pages +│ ├── hooks <-- Custom hooks +│ ├── reducers <-- Redux reducers +│ ├── selectors <-- Source for all Redux selectors +│ └── theme.js <-- Theme file for Material UI +├── yarn-error.log +└── yarn.lock diff --git a/utilities/2--PHLASK-Stack-Docs/2.1--React Docs/2.1.i--Official React Documentation.rtf b/utilities/2--PHLASK-Stack-Docs/2.1--React Docs/2.1.i--Official React Documentation.rtf new file mode 100644 index 00000000..194ecc84 --- /dev/null +++ b/utilities/2--PHLASK-Stack-Docs/2.1--React Docs/2.1.i--Official React Documentation.rtf @@ -0,0 +1,87 @@ +{\rtf1\ansi\ansicpg1252\cocoartf2580 +\cocoatextscaling0\cocoaplatform0{\fonttbl\f0\fswiss\fcharset0 Helvetica-Bold;\f1\fswiss\fcharset0 Helvetica;} +{\colortbl;\red255\green255\blue255;\red251\green2\blue7;\red33\green255\blue255;\red0\green0\blue0; +\red255\green255\blue255;} +{\*\expandedcolortbl;;\cssrgb\c100000\c14913\c0;\cssrgb\c0\c99144\c100000;\cssrgb\c0\c0\c0; +\cssrgb\c100000\c100000\c100000;} +\paperw11900\paperh16840\margl1440\margr1440\vieww22840\viewh15880\viewkind0 +\pard\tx566\tx1133\tx1700\tx2267\tx2834\tx3401\tx3968\tx4535\tx5102\tx5669\tx6236\tx6803\pardirnatural\partightenfactor0 + +\f0\b\fs24 \cf2 \ul \ulc0 Source / Publisher: FaceBook Open Source \cf0 \ +\cb3 [Advice from Billy:\ +\ +==> \'93\'94\ +\ +Part A: +\f1\b0 Description +\f0\b ]\ +\cb1 \ +___// Part A\ +\ +\cf4 I)\'97Getting Started:\ + +\f1\b0 \cf0 \cb5 \ulnone https://legacy.reactjs.org/docs/getting-started.html\ +\ + //==========//\\\\//==========//\ +\ + +\f0\b \ul II)\'97Tutorial:\ + +\f1\b0 \ulnone https://legacy.reactjs.org/tutorial/tutorial.html\ +\ + +\f0\b \ul III)\'97\'93Hello World [!]\'94:\ + +\f1\b0 \ulnone https://legacy.reactjs.org/docs/hello-world.html\ +\ + +\f0\b \ul IV)\'97Accessibility:\ + +\f1\b0 \ulnone https://legacy.reactjs.org/docs/accessibility.html\ +\ + +\f0\b \ul V)\'97Top-Level API\cb1 \ + +\f1\b0 \ulnone https://legacy.reactjs.org/docs/react-api.html\ +\ + +\f0\b \ul VI)\'97Other/\'93Child\'94 Link 4: Intro to Hooks\ + +\f1\b0 \ulnone https://legacy.reactjs.org/docs/hooks-intro.html\ +\ + +\f0\b \ul VII)\'97Other/\'93Child\'94 Link 5; Testing (Overview):\ + +\f1\b0 \ulnone https://legacy.reactjs.org/docs/testing.html\ +\ + +\f0\b \ul VIII)\'97Other/\'93Child\'94 Link 6; AJAX and APIs:\ + +\f1\b0 \ulnone https://legacy.reactjs.org/docs/faq-ajax.html\ +\ + +\f0\b \ul IX)\'97Other/\'93Child\'94 Link 7; React Native:\ + +\f1\b0 \ulnone https://reactnative.dev/\ +\ + +\f0\b \ul X)\'97Other/\'93Child\'94 Link 8; How to Contribute:\ + +\f1\b0 \ulnone https://legacy.reactjs.org/docs/how-to-contribute.html\ +\ + *** *** ***\ + +\f0\b \ul ___// Part B\ +\ +GitHub:\ + +\f1\b0 \ulnone https://github.com/facebook/react/ +\f0\b \ul \ +\ +\ + +\f1\b0 \ulnone \ +\ +} + +Update-example... \ No newline at end of file diff --git a/utilities/2--PHLASK-Stack-Docs/2.2--Google-Maps API/Relevant Links.rtf b/utilities/2--PHLASK-Stack-Docs/2.2--Google-Maps API/Relevant Links.rtf new file mode 100644 index 00000000..184965b1 --- /dev/null +++ b/utilities/2--PHLASK-Stack-Docs/2.2--Google-Maps API/Relevant Links.rtf @@ -0,0 +1,22 @@ +{\rtf1\ansi\ansicpg1252\cocoartf2580 +\cocoatextscaling0\cocoaplatform0{\fonttbl\f0\fswiss\fcharset0 Helvetica-Bold;\f1\fswiss\fcharset0 Helvetica;\f2\fswiss\fcharset0 Helvetica-BoldOblique; +} +{\colortbl;\red255\green255\blue255;} +{\*\expandedcolortbl;;} +\paperw11900\paperh16840\margl1440\margr1440\vieww19500\viewh13240\viewkind0 +\pard\tx566\tx1133\tx1700\tx2267\tx2834\tx3401\tx3968\tx4535\tx5102\tx5669\tx6236\tx6803\pardirnatural\partightenfactor0 + +\f0\b\fs30 \cf0 \ul \ulc0 Relevant Links\ +\pard\tx566\tx1133\tx1700\tx2267\tx2834\tx3401\tx3968\tx4535\tx5102\tx5669\tx6236\tx6803\pardirnatural\partightenfactor0 + +\f1\b0 \cf0 \ulnone \ + +\f0\b 1) +\f1\b0 \ + +\f2\i\b Google Maps Platform API Picker +\f0\i0 :\ + +\f1\b0 https://developers.google.com/maps/documentation/api-picker \ +\ +} \ No newline at end of file diff --git a/utilities/3--debuggingTips.rtf b/utilities/3--debuggingTips.rtf new file mode 100644 index 00000000..eeafb5c4 --- /dev/null +++ b/utilities/3--debuggingTips.rtf @@ -0,0 +1,79 @@ +{\rtf1\ansi\ansicpg1252\cocoartf2580 +\cocoatextscaling0\cocoaplatform0{\fonttbl\f0\fswiss\fcharset0 Helvetica-Bold;\f1\fswiss\fcharset0 Helvetica;\f2\fswiss\fcharset0 Helvetica-BoldOblique; +} +{\colortbl;\red255\green255\blue255;\red255\green255\blue255;\red255\green255\blue10;\red33\green255\blue255; +\red33\green255\blue6;} +{\*\expandedcolortbl;;\cssrgb\c100000\c100000\c100000;\cssrgb\c99942\c98555\c0;\cssrgb\c0\c99144\c100000; +\cssrgb\c0\c97680\c0;} +\paperw11900\paperh16840\margl1440\margr1440\vieww28600\viewh16380\viewkind0 +\pard\tx566\tx1133\tx1700\tx2267\tx2834\tx3401\tx3968\tx4535\tx5102\tx5669\tx6236\tx6803\pardirnatural\partightenfactor0 + +\f0\b\fs28 \cf0 \cb2 \ul \ulc0 Team-Members: Please share any useful / key debugging tips you\'92ve encountered in the past, and the easiest/best ways to solve them! \ + +\f1\b0 \ulnone \ + +\f0\b //\'97\'97\'97\'97\'97//\ +\ul Proposed Template:\ +\ulnone Subject to Review By Dev-Circle Conveners; \'85\ +\ +Esp. Gabe C.: since you\'92ve guided me with this passion project since the beginning, for continuity, I hope you don\'92t mind continuing that kindness?:\ +/\ +\'97Seif S.\ +//\'97\'97\'97\'97\'97//\ +\ + Template for Reporting Notorious Bugs and/or Systemic Issues, etc.:\ + +\f1\b0 \ + ___>> Contributor/dev\'92s name, and duration with the project: \ +\ + ___>> One\'97or some/several\'97of the common bug or issue that you\'92ve faced, and the most effective ways of solving it\'97or, better yet, the best ways to (at least) **trying** not to cause the issue (so to speak).\ +\ + _______>>> Please be thorough\'97state clearly: \ +\cb3 i) How the problem often starts; \ +\cb4 ii) What you suspect--or are confident about\'97based on your past experience\'97to be the cause of the problem. \ +\cb5 iii) And again, the most effective ways of solving it\'97or, better yet, the best ways to (at least) **trying** not to cause the issue (so to speak).\ +\cb2 \ +//\'97\'97\'97\'97\'97\'97\'97\'97\'97\'97\'97\'97\'97//\ +However, despite our waiting for final feedback from the conveners, I suggest we just dive in, and we\'92ll iteratively smoothen out the process over time. Let me (Seif S.) start: \'85\ +//\'97\'97\'97\'97\'97\'97\'97\'97\'97\'97\'97\'97\'97//\ +\ + +\f2\i\b ___>> Contributor/dev\'92s name, and duration with the project: +\f1\i0\b0 \ +\pard\tx566\tx1133\tx1700\tx2267\tx2834\tx3401\tx3968\tx4535\tx5102\tx5669\tx6236\tx6803\pardirnatural\partightenfactor0 +\cf0 \ul >> Seif S.\ +\pard\tx566\tx1133\tx1700\tx2267\tx2834\tx3401\tx3968\tx4535\tx5102\tx5669\tx6236\tx6803\pardirnatural\partightenfactor0 +\cf0 \ulnone \ + +\f2\i\b ___>> One\'97or some/several\'97of the common bug or issue that you\'92ve faced, and the most effective ways of solving it\'97or, better yet, the best ways to (at least) **trying** not to cause the issue (so to speak): \ +\pard\tx566\tx1133\tx1700\tx2267\tx2834\tx3401\tx3968\tx4535\tx5102\tx5669\tx6236\tx6803\pardirnatural\partightenfactor0 + +\f1\i0\b0 \cf0 \ul >> Confusing cloning\'97which is how we\'92re supposed create the local repo in our own GH profiles and on our local machines, with forking!\ + >> Just carefully learn the difference, and carefully implement the right execution\'97cloning, NOT forking!\ +\pard\tx566\tx1133\tx1700\tx2267\tx2834\tx3401\tx3968\tx4535\tx5102\tx5669\tx6236\tx6803\pardirnatural\partightenfactor0 +\cf0 \ulnone \ + +\f0\b _______>>> Please be thorough\'97state clearly: \ + +\f2\i i) How the problem often starts; \ + +\f1\i0\b0 >> This\'97by default happens at the beginning of\'97or resumption with the PHLASK project. \ + The dev necessarily has to catch up to speed with all the ongoing coding initiatives. \ +\ + +\f2\i\b ii) What you suspect--or are confident about\'97based on your past experience\'97to be the cause of the problem. \ + +\f1\i0\b0 >> As I mention above, one just needs to learn the difference. \ +\ + +\f2\i\b iii) And again, the most effective ways of solving it\'97or, better yet, the best ways to (at least) **trying** not to cause the issue (so to speak).\ + +\f1\i0\b0 >> Ditto my previous answer above. \ +\ +\ +\ +\ +\ +\ +\ +} \ No newline at end of file diff --git a/utilities/4--Python Script Prep.rtf b/utilities/4--Python Script Prep.rtf new file mode 100644 index 00000000..5db9bc31 --- /dev/null +++ b/utilities/4--Python Script Prep.rtf @@ -0,0 +1,120 @@ +{\rtf1\ansi\ansicpg1252\cocoartf2580 +\cocoatextscaling0\cocoaplatform0{\fonttbl\f0\fswiss\fcharset0 Helvetica-Bold;\f1\fswiss\fcharset0 Helvetica-BoldOblique;\f2\fswiss\fcharset0 Helvetica; +} +{\colortbl;\red255\green255\blue255;\red255\green255\blue10;} +{\*\expandedcolortbl;;\cssrgb\c99942\c98555\c0;} +\paperw11900\paperh16840\margl1440\margr1440\vieww26700\viewh15080\viewkind0 +\pard\tx566\tx1133\tx1700\tx2267\tx2834\tx3401\tx3968\tx4535\tx5102\tx5669\tx6236\tx6803\pardirnatural\partightenfactor0 + +\f0\b\fs30 \cf0 \ul \ulc0 Python Script Prep\ + +\f1\i \ulnone By Seif S., Dev-Circle\ + +\f2\i0\b0 \ + +\f0\b \ul Part A: Query to ChatGPT\ +\ +My (Seif S.\'92) Query:\ + +\f2\b0 \ulnone \ +\pard\pardeftab720\partightenfactor0 +\cf0 Another important (somewhat related) question; sorry if I asked it before: \ +\ +Please help me generate a brief Python script--which is triggered to be displayed when a developer opens a code-base / forked repo / directory, either via VS Code, or via the local (PC) file explorer (regardless of OS--i.e./e.g., Windows, iOS, linux, etc.)--that welcomes developers, and gives some basic introductory guidance. Specifically, the script should print this message: \ + +\f1\i\b Hello, and welcome aboard, new developer(s)! We're glad to have you as part of the PHLASK team. \ +As you get started with your GH tickets--and PHLASK dev work in general, pease note that you can find a number of resources in the "Utilities" folder/sub-dir. \ +Again, welcome aboard +\f0\i0 ! :-) +\f2\b0 \ +\pard\tx566\tx1133\tx1700\tx2267\tx2834\tx3401\tx3968\tx4535\tx5102\tx5669\tx6236\tx6803\pardirnatural\partightenfactor0 +\cf0 \ +\ +\pard\tx566\tx1133\tx1700\tx2267\tx2834\tx3401\tx3968\tx4535\tx5102\tx5669\tx6236\tx6803\pardirnatural\partightenfactor0 + +\f0\b \cf0 ChatGPT Response:\ +\pard\tx566\tx1133\tx1700\tx2267\tx2834\tx3401\tx3968\tx4535\tx5102\tx5669\tx6236\tx6803\pardirnatural\partightenfactor0 + +\f2\b0 \cf0 \ +To create a Python script that displays a welcome message when a developer opens a code base or directory, you can leverage the use of a simple script file. However, triggering this script automatically when a directory is opened is not straightforward across all operating systems and development environments. Instead, we can create a script that developers can run manually when they start working in the directory.\ +\ +Here's a Python script that prints the welcome message:\ +\ +```python\ +# welcome.py\ +\ +def print_welcome_message():\ + message = """\ + \cb2 Hello, and welcome aboard, new developer(s)! We're glad to have you as part of the PHLASK team.\ + As you get started with your GH tickets--and PHLASK dev work in general, please note that you can find a number of resources in the "Utilities" folder.\ + Again, welcome aboard! :-)\ +\cb1 """\ + print(message)\ +\ +if __name__ == "__main__":\ + print_welcome_message()\ +```\ +\ +### How to Use This Script\ +\ +1. **Place the Script in the Root Directory**: Save the script as `welcome.py` in the root directory of your project.\ +\ +2. **Run the Script**: Instruct developers to run the script manually when they start working in the directory. They can do this by executing the following command in their terminal:\ +\ + ```bash\ + python welcome.py\ + ```\ +\ +### Alternative: Automating the Script Execution (Optional)\ +\ +If you want to automate the execution of this script whenever the directory is opened in a specific IDE like VS Code, you can add a custom task or configure the IDE to run the script on startup. Here\'92s how you can do it for VS Code:\ +\ +#### Setting Up in VS Code\ +\ +1. **Create a Task in VS Code**:\ + - Create or open the `.vscode` folder in the root directory of your project.\ + - Create a file named `tasks.json` inside the `.vscode` folder.\ + - Add the following configuration to `tasks.json`:\ +\ + ```json\ + \{\ + "version": "2.0.0",\ + "tasks": [\ + \{\ + "label": "Welcome Message",\ + "type": "shell",\ + "command": "python welcome.py",\ + "group": \{\ + "kind": "build",\ + "isDefault": true\ + \},\ + "problemMatcher": []\ + \}\ + ]\ + \}\ + ```\ +\ +2. **Run the Task**:\ + - Open the Command Palette in VS Code (Ctrl+Shift+P on Windows/Linux, Cmd+Shift+P on macOS).\ + - Type `Run Task` and select `Tasks: Run Task`.\ + - Choose `Welcome Message` from the list.\ +\ +By setting up this task, developers can easily run the welcome message script from within VS Code.\ +\ +### Summary\ +\ +- **Script**: Create a simple Python script (`welcome.py`) to print the welcome message.\ +- **Manual Execution**: Developers can manually run the script when they start working in the directory.\ +- **VS Code Automation**: Optionally, set up a custom task in VS Code to automate running the script. \ +\ +This approach provides a welcoming message to new developers and guides them to important resources, enhancing their onboarding experience.\ +\ +\pard\tx566\tx1133\tx1700\tx2267\tx2834\tx3401\tx3968\tx4535\tx5102\tx5669\tx6236\tx6803\pardirnatural\qc\partightenfactor0 +\cf0 //==========//\\\\//==========//\\\\//==========//\ +\pard\tx566\tx1133\tx1700\tx2267\tx2834\tx3401\tx3968\tx4535\tx5102\tx5669\tx6236\tx6803\pardirnatural\partightenfactor0 +\cf0 \ + +\f0\b \ul Part B: [Add Details Here]\ + +\f2\b0 \ulnone \ +[And other details here\'85]} \ No newline at end of file diff --git a/utilities/README.md b/utilities/README.md new file mode 100644 index 00000000..914e8053 --- /dev/null +++ b/utilities/README.md @@ -0,0 +1,8 @@ +# PHLASK Utilities Content and Dev Onboarding Directory Purposes/Progress: + +*_1) As of March 3, I have added:* + +___*i) The first main sub-directory--i.e., the **_official_** React documentation links, from Meta / FaceBook Open AI.* + +___*iii) More official and credible/authoritative documentation files or 2nd-level sub-folders will be added incremenally. +