flavor/blog

.firebaserc

@@ -4,6 +4,9 @@
       "hosting": {
         "cms": [
           "jaspero-jms"
+        ],
+        "web": [
+          "jaspero-jms-web"
         ]
       }
     }

.github/workflows/cms.workflow.yml

@@ -7,6 +7,7 @@ on:
     paths:
       - 'definitions/**/*'
       - 'client/projects/cms/**/*'
+      - 'client/projects/shared/**/*'
       - '.github/workflows/cms.workflow.yml'
 jobs:
   deploy:

.github/workflows/dynamic-pages.workflow.yml

@@ -0,0 +1,53 @@
+name: Dynamic Pages
+on:
+  workflow_dispatch:
+    inputs:
+      collection:
+        description: 'Collection to fetch'
+        required: true
+      doc:
+        description: 'ID of the document to fetch'
+        required: true
+      operation:
+        description: 'Type of operation to perform'
+        default: 'create'
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@master
+        with:
+          persist-credentials: false # otherwise, the token used is the GITHUB_TOKEN, instead of the personal token
+          fetch-depth: 0 # otherwise, you will failed to push refs to dest repo
+      - name: Install Dependencies
+        run: |
+          cd build
+          npm ci
+      - name: Build
+        run: |
+          cd build
+          echo $SERVICE_ACCOUNT > account.json
+          node build.js ${{ github.event.inputs.collection }} ${{ github.event.inputs.doc }}
+        env:
+          SERVICE_ACCOUNT: ${{ secrets.SERVICE_ACCOUNT }}
+      - name: Deploy
+        run: |
+          npm install firebase-tools
+          npm run firebase -- use $FIREBASE_PROJECT --token $FIREBASE_TOKEN
+          npm run firebase -- deploy --only hosting:web -m "${{ github.run_id }}" --token $FIREBASE_TOKEN
+        env:
+          FIREBASE_TOKEN: ${{ secrets.FIREBASE_TOKEN }}
+          FIREBASE_PROJECT: 'jaspero-jms'
+      - name: Commit
+        run: |
+          git config --local user.email "action@github.com"
+          git config --local user.name "GitHub Action"
+          git add -f --all public/
+          git commit -m "BOT - Updated build branch for ${{ github.event.inputs.collection }} and ${{ github.event.inputs.doc }}, operation ${{ github.event.inputs.operation }}"
+      - name: Push
+        uses: ad-m/github-push-action@master
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          branch: 'build'
+          force: true

.github/workflows/web.workflow.yml

@@ -0,0 +1,78 @@
+name: Deploy Web
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+    paths:
+      - 'client/projects/web/**/*'
+      - 'client/projects/shared/**/*'
+      - '.github/workflows/web.workflow.yml'
+jobs:
+  deploy:
+    env: 
+      project: 'jaspero-jms'
+      # Release Branch
+      # Only when the workflow is being run on this branch
+      # will it create the build branch
+      release: 'main'
+      # Build Branch
+      # This is the branch that is created on deployment
+      build: 'build'
+    name: Deploy
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repo
+        uses: actions/checkout@master
+        with:
+          persist-credentials: false # otherwise, the token used is the GITHUB_TOKEN, instead of the personal token
+          fetch-depth: 0 # otherwise, it fails to push refs to dest repo
+      - name: Use Node.js 16.x
+        uses: actions/setup-node@v1
+        with:
+          node-version: 16.x
+      - name: Install Dependencies
+        run: |
+          npm --prefix client ci
+      - name: Build
+        run: npm run build:web
+      - name: Build.js
+        if: contains(github.ref, env.release)
+        run: |
+          cd build
+          echo $SERVICE_ACCOUNT > account.json
+          npm ci
+          node build.js
+          cd ..
+        env:
+          SERVICE_ACCOUNT: ${{ secrets.SERVICE_ACCOUNT }}
+      - name: Deploy to Firebase
+        uses: w9jds/firebase-action@master
+        with:
+          args: deploy --only hosting:web
+        env:
+          FIREBASE_TOKEN: ${{ secrets.FIREBASE_TOKEN }}
+          PROJECT_ID: ${{ env.project }}
+      - name: Commit
+        if: contains(github.ref, env.release)
+        run: |
+          git config --local user.email "action@github.com"
+          git config --local user.name "GitHub Action"
+          git add -f --all public/
+          git commit -m "BOT - Connected build branch"
+      - name: Update current app version
+        if: contains(github.ref, env.release)
+        run: |
+          cd build
+          echo $SERVICE_ACCOUNT > account.json
+          node update-current-version.js
+        env:
+          SERVICE_ACCOUNT: ${{ secrets.SERVICE_ACCOUNT }}
+      - name: Push
+        if: contains(github.ref, env.release)
+        uses: ad-m/github-push-action@master
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          branch: ${{ env.build }}
+          force: true
+

CHANGELOG.md

@@ -895,17 +895,15 @@
 
 ## [4.4.3](https://github.com/jaspero/jms/compare/v4.4.2...v4.4.3) (2021-07-24)
 
-
 ### Bug Fixes
 
-* **client:** missing translation on name instance overview ([cea707d](https://github.com/jaspero/jms/commit/cea707d6adf6b4bd041a2dad7d124635ea60f41f))
+- **client:** missing translation on name instance overview ([cea707d](https://github.com/jaspero/jms/commit/cea707d6adf6b4bd041a2dad7d124635ea60f41f))
 
 ## [4.4.2](https://github.com/jaspero/jms/compare/v4.4.1...v4.4.2) (2021-07-20)
 
-
 ### Bug Fixes
 
-* translation missmatch for user-invites ([17c4254](https://github.com/jaspero/jms/commit/17c4254003aee3452adca8a2dea93c47a23fc8df))
+- translation missmatch for user-invites ([17c4254](https://github.com/jaspero/jms/commit/17c4254003aee3452adca8a2dea93c47a23fc8df))
 
 ## [4.4.1](https://github.com/jaspero/jms/compare/v4.4.0...v4.4.1) (2021-07-20)
 

README.md

@@ -1,23 +1,17 @@
-![Release](https://github.com/Jaspero/jms/workflows/Release/badge.svg)
-![Deploy CMS](https://github.com/Jaspero/jms/workflows/Deploy%20CMS/badge.svg)
-![Deploy Functions](https://github.com/Jaspero/jms/workflows/Deploy%20Functions/badge.svg)
-![Deploy Firestore Indexes](https://github.com/Jaspero/jms/workflows/Deploy%20Firestore%20Indexes/badge.svg)
-![Deploy Storage Rules](https://github.com/Jaspero/jms/workflows/Deploy%20Storage%20Rules/badge.svg)
-![Deploy Rules](https://github.com/Jaspero/jms/workflows/Deploy%20Rules/badge.svg)
-![Lighthouse CI](https://github.com/Jaspero/jms/workflows/Lighthouse%20CI/badge.svg)
+# JMS flavor/blog
 
-# JMS
+This flavor of JMS comes with everything preconfigured for a simple blog. 
+It consists of two angular projects CMS and Web.
 
-JMS is a CMS based on Angular that is fully configurable through JSON schema-s. JMS is very
-opinionated especially when it comes to things like templating engines and email services, even though this should be easily interchangeable. 
+## Checklist
 
-Currently it only supports [firestore](https://firebase.google.com/docs/firestore) as its
-back-end but other implementations are planed and instructions for writing your own integration can
-be found in the [wiki](https://github.com/Jaspero/jms/wiki/Custom-Integrations).
+Before going live make sure you've marked all of the following:
 
-A live example can be found [here](https://jaspero-jms.web.app/).
-
-For more information consult our [wiki](https://github.com/Jaspero/jms/wiki).
-
-**Note:** JMS is in active development and shouldn't be used in a production environment. Progress
-towards our production ready goal can be tracked [here](https://github.com/Jaspero/jms/projects/1).
+- [ ] `storage.rules` have rules configured for all of the modules
+- [ ] You adjusted the constants in `build/build.js` to fit your projects requirements and added any static or dynamic pages to the `PAGES` array.
+- [ ] `client/projects/cms/src/environment/static-config.ts` has been adjusted to your projects requirements.
+- [ ] You added `FIREBASE_TOKEN` and `SERVICE_ACCOUNT` to your secrets in github.
+- [ ] You adjusted `client/projects/web/scr/app/consts/base-title.const.ts` to your projects title.
+- [ ] You changed "jaspero-jms" in `.github/workflows/web.workflow.yml` and `.github/workflows/cms.workflow.yml` to your project id
+- [ ] You updated `.firebaserc` with your projects data
+- [ ] You changed the meta tags in `client/projects/web/src/index.html`

build/.gitignore

@@ -0,0 +1,2 @@
+node_modules
+account.json

build/build.js

@@ -0,0 +1,113 @@
+const {join} = require('path');
+const {readFileSync} = require('fs');
+const admin = require('firebase-admin');
+const renderDocument = require('./src/render-document');
+const renderMeta = require('./src/render-meta');
+const siteMap = require('./src/site-map');
+const URL = 'https://jaspero-jms.web.app/';
+const BASE_PATH = join(__dirname, '..', 'public/web');
+const BASE_TITLE = 'JMS';
+const DELIMITER = '-';
+const BASE_URL = 'https://firebasestorage.googleapis.com/v0/b/jaspero-jms.appspot.com/o/';
+const PAGES = [
+  {
+    url: '',
+    collection: 'pages',
+    id: doc => doc.id,
+    title: item => item.meta?.title || item.title,
+    meta: item => ({
+      description: item.meta?.description || ''
+    }),
+    metaProperties: async item => {
+
+      if (!item.meta) {
+        return {};
+      }
+
+      const thumb = item.meta.image ? `${BASE_URL}generated%2Fthumb_m_${item.meta.image.split(BASE_URL)[1]}` : `${URL}/assets/img/logo.png`;
+      const description = item.meta.description;
+      return {
+        ['og:type']: 'article',
+        ['og:url']: `${URL}/${item.id}`,
+        ['og:title']: item.meta.title,
+        ['og:description']: description,
+        ['og:image']: thumb,
+        ['twitter:card']: 'summary_large_image',
+        ['twitter:url']: `${URL}/${item.id}`,
+        ['twitter:title']: item.meta.title,
+        ['twitter:description']: description,
+        ['twitter:image']: thumb
+      }
+    }
+  },
+  {
+    url: '404',
+    title: '404',
+    meta: {
+      description: '',
+      keywords: ''
+    },
+    metaProperties: {
+      ['og:title']: '',
+      ['og:description']: '',
+      ['twitter:title']: '',
+      ['twitter:description']: '',
+    }
+  }
+];
+
+async function createPages(collection, id) {
+
+  const index = readFileSync(join(BASE_PATH, 'index.html')).toString();
+  admin.initializeApp({
+    credential: admin.credential.cert(require('./account.json'))
+  });
+
+  const fStore = admin.firestore();
+
+  if (collection && id) {
+    const pg = PAGES.find(p => p.collection === collection);
+    const doc = await fStore.collection(pg.collection).doc(id).get();
+    await renderDocument(DELIMITER, BASE_TITLE, BASE_PATH, index, pg, doc);
+    return;
+  }
+
+  const sitemapPages = [];
+
+  await Promise.all(
+    PAGES.map(async pg => {
+      if (pg.collection) {
+        const docs = await (pg.criteria ? pg.criteria(fStore.collection(pg.collection)) : fStore.collection(pg.collection)).get();
+
+        await Promise.all(
+          docs.docs.map(async doc => {
+            sitemapPages.push({
+              url: `${URL}${pg.url.replace(/^\//, '')}/${pg.id(doc)}`
+            });
+            await renderDocument(DELIMITER, BASE_TITLE, BASE_PATH, index, pg, doc);
+          })
+        )
+      } else {
+        sitemapPages.push({
+          url: `${URL}${pg.url.replace(/^\//, '')}`
+        });
+        await renderMeta(
+          DELIMITER,
+          BASE_TITLE,
+          index,
+          pg,
+          join(BASE_PATH, pg.url + '.html')
+        )
+      }
+    })
+  );
+
+  await siteMap(BASE_PATH, sitemapPages);
+}
+
+createPages(process.argv[3] || '', process.argv[4] || '')
+  .then(() => process.exit())
+  .catch(e => {
+    console.error(e);
+    process.exit(1)
+  });