Release v2.3.1

.env.sample

@@ -0,0 +1,3 @@
+BUILD_ENV=
+COMMUNITY_API_KEY=
+THEGRAPH_API_KEY=

.github/workflows/preprod.yml → .github/workflows/branch.yml

@@ -1,14 +1,15 @@
-name: Test and deploy to pre-production
+name: Test and deploy to branch
 
 on:
   push:
     branches:
+      - master
       - preprod
       - develop
 
 jobs:
   validate:
-    name: Validate pre-production
+    name: Validate branch
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
@@ -29,25 +30,25 @@ jobs:
         run: npm run build
 
   deploy:
-    name: Deploy to pre-production
+    name: Deploy to branch
     runs-on: ubuntu-latest
     needs: validate
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Login to registry
-        uses: docker/login-action@v2
+        uses: docker/login-action@v3
         with:
           registry: ${{ secrets.DOCKER_REGISTRY }}
           username: ${{ secrets.DOCKER_LOGIN }}
           password: ${{ secrets.DOCKER_PASSWD }}
 
       - name: Build and push Docker image
-        uses: docker/build-push-action@v4
+        uses: docker/build-push-action@v5
         with:
           context: .
           push: true
-          tags: registry.realt.community/realtdashboard_preprod:latest
+          tags: ${{ secrets.DOCKER_REGISTRY }}/dashboard:${{ github.ref_name }}
 
       - name: Configure SSH
         run: |
@@ -68,10 +69,14 @@ jobs:
           SSH_HOST: ${{ secrets.SSH_HOST }}
           SSH_PORT: ${{ secrets.SSH_PORT }}
 
-      - name: Update pre-production environment
+      - name: Update branch environment
         run: |
-          ssh staging 'cd /home/realt/docker/dashboard-v2/preprod
-          git pull origin develop
-          docker compose --file docker-compose-preprod.yml pull
-          docker login -u ${{ secrets.DOCKER_LOGIN }} -p ${{ secrets.DOCKER_PASSWD }} ${{ secrets.DOCKER_REGISTRY }}
-          docker compose --file docker-compose-preprod.yml up -d'
+          ssh staging 'export DOCKER_BRANCH=${{ github.ref_name }} DOCKER_REGISTRY=${{ secrets.DOCKER_REGISTRY }}
+          cd /var/docker/dashboard-v2/${DOCKER_BRANCH}
+          git pull origin ${DOCKER_BRANCH}
+          docker compose --file docker-compose-branch.yml pull
+          docker login -u ${{ secrets.DOCKER_LOGIN }} -p ${{ secrets.DOCKER_PASSWD }} ${DOCKER_REGISTRY}
+          THEGRAPH_API_KEY=${{ secrets.THEGRAPH_API_KEY }} \
+          COMMUNITY_API_KEY=${{ secrets.COMMUNITY_API_KEY }} \
+          HOSTNAME=${{ github.ref_name == 'master' && 'dashboard.realt.community' || 'dashboard.${DOCKER_BRANCH}.realt.community' }} \
+          docker compose --project-name ${{ github.ref_name }}-dashboard --file docker-compose-branch.yml up -d'

.prettierrc.js

@@ -0,0 +1,21 @@
+module.exports = {
+  tabWidth: 2,
+  useTabs: false,
+  singleQuote: true,
+  jsxSingleQuote: true,
+  semi: false,
+  endOfLine: 'auto',
+
+  plugins: [require.resolve('@trivago/prettier-plugin-sort-imports')],
+  importOrder: [
+    '^react',
+    '^next',
+    '^@(.*)$',
+    '^i18next(.*)',
+    '^(?!(src|../|./))(.*)',
+    '^src(.*)$',
+    '^(.*)$'
+  ],
+  importOrderSeparation: true,
+  importOrderSortSpecifiers: true,
+}

README.md

@@ -18,10 +18,13 @@ To run the project you will need to set-up a `.env` file in the root folder:
 
 ```
 COMMUNITY_API_KEY=XXXXXXXXXXXX
+THEGRAPH_API_KEY=XXXXXXXXXXXX
 ```
 
 To get a `COMMUNITY_API_KEY`, join the dedicated [telegram dev channel](https://t.me/+XQyoaFfmN61yk7X0) then ask for.
 
+To get a THEGRAPH_API_KEY, you need to create an account on thegraph.com [Thegraph docs](https://thegraph.com/docs/en/querying/managing-api-keys/)
+
 ### Node.js version
 
 <strong>📣 Node.js needed version is `v18.12.1`</strong>

docker-compose-branch.yml

@@ -0,0 +1,19 @@
+services:
+  app:
+    image: ${DOCKER_REGISTRY}/dashboard:${DOCKER_BRANCH}
+    container_name: ${DOCKER_BRANCH}-dashboard
+    environment:
+      - THEGRAPH_API_KEY=$THEGRAPH_API_KEY
+      - COMMUNITY_API_KEY=$COMMUNITY_API_KEY
+    networks:
+      - traefik-realt
+    labels:
+      - 'traefik.enable=true'
+      - 'traefik.http.routers.dashboard-${DOCKER_BRANCH}.rule=Host(`${HOSTNAME}`)'
+      - 'traefik.http.routers.dashboard-${DOCKER_BRANCH}.entrypoints=websecure'
+      - 'traefik.http.services.dashboard-${DOCKER_BRANCH}.loadbalancer.server.port=3000'
+    restart: always
+
+networks:
+  traefik-realt:
+    external: true