Merge pull request #42 from acmutd/dev

Release 1.0.0

.github/ISSUE_TEMPLATE/bug-report.md

@@ -0,0 +1,27 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: "[Bug]"
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Additional context**
+Add any other context about the problem here. Include potential fix solutions if known for the developers.

.github/ISSUE_TEMPLATE/feature-addition.md

@@ -0,0 +1,19 @@
+---
+name: Feature Addition
+about: New enhancement or feature that will be added to the application
+title: "[Feature]"
+labels: enhancement
+assignees: ''
+
+---
+
+**Describe new addition**
+A clear and concise description of what feature or technology will be incorporated into the application. This could be a UI or a backend feature. Ex. Create a data store for the application through Redux to [...]
+
+**Task List**
+Create the acceptance criteria to determine when the issue can be marked as resolved. This needs to be as detailed as possible to simplify the process of conducting code reviews when the feature is in development. Ex.
+ - [ ] Add Redux Actions for authentication
+ - [ ] Add Redux Reducers for authentication
+
+**Additional context**
+Add any other context/notes about the feature request here.

.github/ISSUE_TEMPLATE/internal-update.md

@@ -0,0 +1,20 @@
+---
+name: Internal Update
+about: Changes that deal with documentation, refactoring, testing or deployment
+title: "[Internal]"
+labels: internal
+assignees: ''
+
+---
+
+**Describe the issue**
+Describe briefly the changes involved and why they are being made
+
+**Task List**
+ - For documentation, describe the version that it targets and who the audience is (users, developers, etc)
+ - For test cases, create a detailed list of the exact test cases that need to be created.
+ - For refactoring, be specific in what code is being changed, whether it affects any functionality and finally how the workflow will be after the issue is resolved
+ - For Deployment, describe if the issue is non-code related, the change in how the user will find/interact with the application. Detail how the change differs from previous situation
+
+**Additional Context**
+Add in any other relevant information to make the issue more detailed.

.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

@@ -0,0 +1,14 @@
+#### Pull Request `<Insert Branch Name>`
+
+Short & brief description of branch and what bug, feature or internal change was being made
+
+#### Details
+ - Create bullet point list of changes made
+
+
+#### Resolved Issues and Linked References
+ - resolves #`<insert issue number>`
+ - The resolves keyword (can also use closes and a couple others) will ensure that the relevant issue gets moved into the finished pile
+ - Reference #`<insert pr number>`
+
+#### Additional Notes

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,54 @@
+name: "Code scanning - action"
+
+on:
+  push:
+    branches: [dev, master]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [dev]
+  schedule:
+    - cron: '0 12 * * 4'
+
+jobs:
+  CodeQL-Build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+      with:
+        # We must fetch at least the immediate parents so that if this is
+        # a pull request then we can checkout the head.
+        fetch-depth: 2
+
+    # If this run was triggered by a pull request event, then checkout
+    # the head of the pull request instead of the merge commit.
+    - run: git checkout HEAD^2
+      if: ${{ github.event_name == 'pull_request' }}
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      # Override language selection by uncommenting this and choosing your languages
+      # with:
+      #   languages: go, javascript, csharp, python, cpp, java
+
+    # 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

.github/workflows/nodejs.yaml

@@ -0,0 +1,53 @@
+name: ACM API Continuous Integration
+env:
+  REACT_APP_AUTH0_DOMAIN: ${{ secrets.REACT_APP_AUTH0_DOMAIN }}
+  REACT_APP_AUTH0_CLIENTID: ${{ secrets.REACT_APP_AUTH0_CLIENTID }}
+  REACT_APP_AUTH0_AUDIENCE: ${{ secrets.REACT_APP_AUTH0_AUDIENCE }}
+
+on:
+  push:
+    branches: [dev, master]
+  pull_request:
+    branches: [dev, master]
+
+jobs:
+  build:
+    name: Clean install, build and test
+
+    #timeout-minutes: 10 #fail if the process takes >10 minutes
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [10.x] #test on 10.x to match firebase deployment environment
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Use Node.js ${{ matrix.node-version }}
+      - uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: cd functions/
+      - run: npm ci #clean install
+      - run: npm run build --if-present #same as npm run build
+      - run: npm test #run jest & enzyme testing for application
+
+  #automated deployment to firebase (if the build passes)
+  deploy:
+    name: Firebase deployment script
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [10.x] #will add 12.x later
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Deploy to firebase environment with Node.js ${{ matrix.node-version }}
+      - uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: cd functions/
+      - run: echo "deploying to firebase... (but like not really)"
+        # - runs: npm run deploy

.gitignore

@@ -11,6 +11,7 @@ firebase-debug.log*
 
 # Firebase config
 acm-core-service-account.json
+.runtimeconfig.json
 
 # Uncomment this if you'd like others to create their own Firebase project.
 # For a team working on the same Firebase project(s), it is recommended to leave
@@ -65,3 +66,5 @@ node_modules/
 # dotenv environment variables file
 .env
 
+#macOS
+.DS_Store

firebase.json

@@ -3,6 +3,18 @@
     "predeploy": [
       "npm --prefix \"$RESOURCE_DIR\" run lint",
       "npm --prefix \"$RESOURCE_DIR\" run build"
-    ]
+    ],
+    "source": "functions"
+  },
+  "emulators": {
+    "functions": {
+      "port": 5002
+    },
+    "firestore": {
+      "port": 8080
+    },
+    "ui": {
+      "enabled": true
+    }
   }
 }

functions/.eslintrc.js

@@ -0,0 +1,18 @@
+module.exports = {
+  root: true,
+  parser: "@typescript-eslint/parser",
+  plugins: ["@typescript-eslint"],
+  extends: [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "prettier/@typescript-eslint",
+    "plugin:prettier/recommended",
+  ],
+  env: {
+    node: true,
+  },
+  ignorePatterns: ["lib/*"],
+  rules: {
+    "@typescript-eslint/no-namespace": [2, { allowDeclarations: true }],
+  },
+};

functions/.gitignore

@@ -1,6 +1,5 @@
 ## Compiled JavaScript files
-**/*.js
-**/*.js.map
+lib/
 
 # Typescript v1 declaration files
 typings/

functions/.prettierrc.js

@@ -0,0 +1,3 @@
+module.exports = {
+  printWidth: 120,
+};