JSON to markdown

.github/workflows/black-linter.yml

@@ -3,12 +3,12 @@ name: Black style check
 on:
   push:
     paths:
-      - "**.py"
+      - "src/**/*.py"
     branches:
       - develop
   pull_request:
     paths:
-      - "**.py"
+      - "src/**/*.py"
     branches:
       - develop
 

.github/workflows/deploy-wiki.yml

@@ -1,25 +1,30 @@
-name: Deploy Wiki
-
-on:
-  push:
-    paths:
-      - "docs/**"
-    branches:
-      - develop
-
-jobs:
-  update-wiki:
-    runs-on: ubuntu-latest
-    name: Update wiki
-    steps:
-      - name: Set up Git repository
-        uses: actions/checkout@v2
-      - name: Copy file
-        run: cp docs/index.md docs/Home.md
-      - uses: ineshbose/wiki-action@v1
-        with:
-          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          WIKI_DIR: "docs"
-          WIKI_IGNORE: "requirements.txt index.md .gitignore README.md"
-          AUTO_SIDEBAR: true
-          SIDEBAR_IGNORE: "archive assets env Home.md"
+name: Deploy Wiki
+
+on:
+  push:
+    paths:
+      - "docs/**"
+    branches:
+      - develop
+
+jobs:
+  update-wiki:
+    runs-on: ubuntu-latest
+    name: Update wiki
+    steps:
+      - name: Set up Git repository
+        uses: actions/checkout@v2
+      - name: Install dependencies and run script
+        working-directory: ./docs
+        run: |
+          yarn
+          npx ts-node meetings/generate.ts meetings/ meetings/meetings.t.md
+      - name: Copy file
+        run: cp docs/index.md docs/Home.md
+      - uses: ineshbose/wiki-action@v1
+        with:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          WIKI_DIR: "docs"
+          WIKI_IGNORE: "requirements.txt index.md .gitignore README.md *.t.md *.ts *.js"
+          AUTO_SIDEBAR: true
+          SIDEBAR_IGNORE: "archive assets env Home.md"

.github/workflows/eslint-check.yml

@@ -3,18 +3,12 @@ name: ESLint/Prettier/Airbnb style check
 on:
   push:
     paths:
-      - "**/*.js"
-      - "**/*.ts"
-      - "**/*.jsx"
-      - "**/*.tsx"
+      - "src/**/*.[jt]sx?"
     branches:
       - develop
   pull_request:
     paths:
-      - "**/*.js"
-      - "**/*.ts"
-      - "**/*.jsx"
-      - "**/*.tsx"
+      - "src/**/*.[jt]sx?"
     branches:
       - develop
 

.gitignore

@@ -17,5 +17,12 @@ tmp
 .idea
 
 # Dependencies
-env
-node_modules
+/node_modules
+/__pycache__
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/

docs/.eslintrc.js

@@ -0,0 +1,22 @@
+module.exports = {
+  extends: [
+    'airbnb-typescript',
+    'plugin:import/recommended',
+    'plugin:import/typescript',
+    'prettier',
+    'plugin:prettier/recommended',
+  ],
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    ecmaVersion: 13,
+    sourceType: 'module',
+    project: 'tsconfig.eslint.json',
+    tsconfigRootDir: __dirname,
+  },
+  plugins: ['@typescript-eslint', 'import', 'prettier'],
+  ignorePatterns: ['env'],
+  rules: {
+    'prettier/prettier': ['error', { singleQuote: true }],
+    'react/jsx-filename-extension': 'off',
+  },
+};

docs/.gitignore

@@ -1,26 +1,26 @@
-# Dependencies
-/node_modules
-/__pycache__
-.env
-.venv
-env/
-venv/
-ENV/
-env.bak/
-venv.bak/
-
-# Build files
-/build
-/MANIFEST
-/site
-
-# Distribution files
-/dist
-/mkdocs_material.egg-info
-
-# Caches and logs
-*.cpuprofile
-*.log
-*.tsbuildinfo
-.cache
+# Dependencies
+/node_modules
+/__pycache__
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Build files
+/build
+/MANIFEST
+/site
+
+# Distribution files
+/dist
+/mkdocs_material.egg-info
+
+# Caches and logs
+*.cpuprofile
+*.log
+*.tsbuildinfo
+.cache
 .eslintcache

docs/meetings/2021-10-01.json

@@ -0,0 +1,57 @@
+{
+  "datetime": "01-10-2021 11:30",
+  "purpose": "Introduction",
+  "location": "Zoom",
+  "attendees": ["ineshbose", "oanaandrei"],
+  "agenda": [
+    {
+      "item": "Self-introduction",
+      "description": ["Names, pronunciation", "Previous projects/experience"]
+    },
+    {
+      "item": "App discussion",
+      "description": [
+        "Who are the end users?",
+        "Description beyond the text on the project listing"
+      ]
+    },
+    {
+      "item": "Strategy",
+      "description": [
+        "Development strategy",
+        "Priorities",
+        "Meetings scheduling"
+      ]
+    }
+  ],
+  "discussion": [
+    {
+      "item": "App background",
+      "who": "oanaandrei",
+      "notes": "The idea of Portion Mate came from Dr. Andrei trying to keep track of her portion in take on paper and now looking for a mobile app; therefore, she's the end user. There needs to be an input table for the Eatwell Guide, and being able to put in the meals/snacks taken during the day."
+    },
+    {
+      "item": "Essential features",
+      "who": "oanaandrei",
+      "notes": "Some essential features (app should have) are being able to send a reminder to a user at mid-day (around 14:00) and at the end of the day (around 21:00-22:00) to log their portions, being able to display portion statistics weekly/monthly, and sending notifications if the logs do not follow the plan (Eatwell Guide)."
+    },
+    {
+      "item": "Priorities",
+      "who": "oanaandrei",
+      "notes": "There should be priority on ease and convenience rather than functionality and details, otherwise the app becomes too complicated. This means that there should be vague portion sizes for easier understanding (like \"a fist of pasta\") with examples of portion sizes. This will help users to stay committed than to leave after a week."
+    },
+    {
+      "item": "Development Strategy",
+      "who": "ineshbose",
+      "notes": "For the project, issue tracking will be used and shared; this will allow prioritising features. For the meetings, agenda should be sent before hand over email. As for this week, the plan is to research into similar apps and share thoughts."
+    }
+  ],
+  "actions": [
+    {
+      "item": "Schedule regular meeting",
+      "who": ["ineshbose", "oanaandrei"],
+      "done": true
+    }
+  ],
+  "notes": ""
+}

docs/meetings/2021-10-08.json

@@ -0,0 +1,42 @@
+{
+  "datetime": "08-10-2021 11:30",
+  "purpose": "Catchup",
+  "location": "Zoom",
+  "attendees": ["ineshbose", "oanaandrei"],
+  "agenda": [
+    {
+      "item": "Initial progress",
+      "description": [
+        "Share [research](research)",
+        "Repository information & setup"
+      ]
+    },
+    {
+      "item": "Confusions",
+      "description": [
+        "Unable to comprehend the paper log",
+        "Get an actual log instead of an example if possible"
+      ]
+    }
+  ],
+  "discussion": [
+    {
+      "item": "Technology chosen",
+      "who": "ineshbose",
+      "notes": "The frameworks have been decided to be Django and React Native for backend and frontend respectively, and there will be a slight learning curve. Through the research, some ideas like UI design and elements were discussed."
+    },
+    {
+      "item": "Paper logs",
+      "who": "oanaandrei",
+      "notes": "The \"input table\" indicate how many portions are aimed for each day through the number of cells, and each cell should be crossed off. To understand better, an actual log was requested from Dr. Andrei's diary."
+    }
+  ],
+  "actions": [
+    {
+      "item": "Get actual paper logs",
+      "who": ["oanaandrei"],
+      "done": true
+    }
+  ],
+  "notes": ""
+}

docs/meetings/2021-10-15.json

@@ -0,0 +1,35 @@
+{
+  "datetime": "15-10-2021 11:30",
+  "purpose": "Catchup",
+  "location": "Zoom",
+  "attendees": ["ineshbose", "oanaandrei"],
+  "agenda": [
+    {
+      "item": "Repository setup",
+      "description": [
+        "Using the provided template",
+        "Centralised files",
+        "Includes meeting notes, dissertation, source"
+      ]
+    },
+    {
+      "item": "Share more research",
+      "description": ["Scoped requirements", "Designed models/entities"]
+    }
+  ],
+  "discussion": [
+    {
+      "item": "Requirements",
+      "who": "ineshbose",
+      "notes": "The requirements were formalised, however more will come up over the course as the app is being developed. Along with that, an ER diagram was designed to understand how logging will work through a linear three model system. This will be the structure in the backend (and) database through Django."
+    }
+  ],
+  "actions": [
+    {
+      "item": "Confirm Access to Repository",
+      "who": "oanaandrei",
+      "done": true
+    }
+  ],
+  "notes": ""
+}

docs/meetings/2021-10-22.json

@@ -0,0 +1,30 @@
+{
+  "datetime": "22-10-2021 11:30",
+  "purpose": "Catchup",
+  "location": "Zoom",
+  "attendees": ["ineshbose", "oanaandrei"],
+  "agenda": [
+    {
+      "item": "Repository automation",
+      "description": ["Workflow setup", "Using GitHub features"]
+    },
+    {
+      "item": "Block 2 plan",
+      "description": []
+    }
+  ],
+  "discussion": [
+    {
+      "item": "Repository setup",
+      "who": "ineshbose",
+      "notes": "The repository was polished more as issue tracking was promised, therefore coding started with the pipelines rather than the app itself. This was displayed with a demonstration of how issues are linked to card on the automated Kanban Boards, along with issue templates and labels, that would be connected to branches created by automation."
+    },
+    {
+      "item": "Current plan",
+      "who": "oanaandrei",
+      "notes": "More specifications were formalised - mostly user stories/personas. By now, Block 1 (as devised by Dr. Andrei, and used as a planning period) should be wrapped, and Block 2 has started (setup & development period). The current task is to work on Block 2 tasks, and finish the few remaining Block 1 tasks (wireframes)."
+    }
+  ],
+  "actions": [],
+  "notes": ""
+}