chore(#57): migrate the project to Next.js

For now, this is a simple empty shell but with the following elements already configured: - CircleCI - DevContainers - Taskfile
damien-carcel · Nov 11, 2023 · dc4b2c2 · dc4b2c2
1 parent 1b93a0a
commit dc4b2c2
Show file tree

Hide file tree

Showing 61 changed files with 3,952 additions and 10,743 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -1,45 +1,74 @@
 version: 2.1
 
 workflows:
-    pull_request:
-        jobs:
-            - tests:
-                  context:
-                      - docker-hub-credentials
-                  filters:
-                      branches:
-                          ignore:
-                              - index
+  pull_request:
+    jobs:
+      - tests:
+          context:
+            - docker-hub-credentials
+          filters:
+            branches:
+              ignore:
+                - main
 
 jobs:
-    tests:
-        docker:
-            - image: node:18
-        steps:
-            - checkout
-            - run:
-                  name: Create Yarn cache and configuration directories and files
-                  command: ./.devcontainer/setup.sh
-            - run:
-                  name: Install the latest Task binary
-                  command: npm install -g @go-task/cli
-            - restore_cache:
-                  keys:
-                      - yarn-{{ .Environment.CACHE_VERSION }}-{{ checksum "yarn.lock" }}
-                      - yarn-{{ .Environment.CACHE_VERSION }}-
-            - run:
-                  name: Install dependencies
-                  command: task dependencies:install
-            - save_cache:
-                  key: yarn-{{ .Environment.CACHE_VERSION }}-{{ checksum "yarn.lock" }}
-                  paths:
-                      - ~/.cache/yarn
-            - run:
-                  name: Lint the stylesheets
-                  command: task tests:stylelint:check
-            - run:
-                  name: Check the code style
-                  command: task tests:prettier:check
-            - run:
-                  name: Lint the TS code
-                  command: task tests:eslint:check
+  tests:
+    machine:
+      image: ubuntu-2204:2023.07.2
+    steps:
+      - checkout
+      - run:
+          name: Install the latest Task binary
+          command: npm install -g @go-task/cli
+      - run:
+          name: Pull Docker images
+          command: task docker:pull
+      - run:
+          name: Create cache and configuration directories for the front-end dependencies
+          command: task setup:yarn
+      - restore_cache:
+          keys:
+            - yarn-{{ .Environment.CACHE_VERSION }}-{{ checksum "yarn.lock" }}
+            - yarn-{{ .Environment.CACHE_VERSION }}-
+      - run:
+          name: Ensure write permissions for Docker containers
+          command: sudo chown -R 1000:1000 ../project ~/.yarnrc ~/.config/yarn ~/.cache/yarn ~/.cache/Cypress
+      - run:
+          name: Install dependencies
+          command: |
+            task dependencies:install
+            task dependencies:cypress
+      - save_cache:
+          key: yarn-{{ .Environment.CACHE_VERSION }}-{{ checksum "yarn.lock" }}
+          paths:
+            - ./node_modules
+            - ./.next/cache
+      - run:
+          name: Check the code style
+          command: task tests:check-code-style
+      - run:
+          name: Lint the stylesheets
+          command: task tests:lint-css
+      - run:
+          name: Lint the application code
+          command: task tests:lint-ts -- --format junit -o test_results/eslint.xml
+      - run:
+          name: Check the code typing
+          command: task tests:check-types
+      - run:
+          name: Run unit tests
+          environment:
+            JEST_JUNIT_OUTPUT_DIR: test_results
+            JEST_JUNIT_OUTPUT_NAME: unit.xml
+          command: task tests:unit-tests -- --reporters=default --reporters=jest-junit
+      - run:
+          name: Run component tests
+          command: task tests:component-tests-headless
+      - run:
+          name: Run end-to-end tests
+          command: |
+            task run:database
+            task run:migrate
+            task tests:e2e-tests-headless
+      - store_test_results:
+          path: test_results
diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile
diff --git a/.devcontainer/compose.yaml b/.devcontainer/compose.yaml
diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json
@@ -1,25 +1,24 @@
 {
-    "dockerComposeFile": ["../compose.yaml", "./compose.yaml"],
-    "customizations": {
-        "vscode": {
-            "extensions": [
-                "CircleCI.circleci",
-                "dbaeumer.vscode-eslint",
-                "eamodio.gitlens",
-                "esbenp.prettier-vscode",
-                "github.vscode-github-actions",
-                "ms-azuretools.vscode-docker",
-                "redhat.vscode-yaml",
-                "task.vscode-task",
-                "yzhang.markdown-all-in-one"
-            ]
-        }
-    },
-    "initializeCommand": "./.devcontainer/setup.sh",
-    "name": "carcel.dev",
-    "postCreateCommand": "task dependencies:install",
-    "runServices": ["dev", "prod"],
-    "remoteUser": "node",
-    "service": "devcontainer",
-    "workspaceFolder": "/srv/app"
+  "dockerComposeFile": ["../compose.yaml"],
+  "customizations": {
+    "vscode": {
+      "extensions": [
+        "CircleCI.circleci",
+        "dbaeumer.vscode-eslint",
+        "eamodio.gitlens",
+        "esbenp.prettier-vscode",
+        "github.vscode-github-actions",
+        "ms-azuretools.vscode-docker",
+        "redhat.vscode-yaml",
+        "task.vscode-task",
+        "yzhang.markdown-all-in-one"
+      ]
+    }
+  },
+  "initializeCommand": "task dependencies:install",
+  "name": "carcel.dev",
+  "runServices": ["dev", "prod"],
+  "remoteUser": "node",
+  "service": "node",
+  "workspaceFolder": "/srv/app"
 }
diff --git a/.devcontainer/setup.sh b/.devcontainer/setup.sh
diff --git a/.eslintignore b/.eslintignore
@@ -1,4 +1,6 @@
 .cache
 .netlify
-node_modules
-public/build
+.next
+/netlify/
+/node_modules
+/public
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -1,4 +1,3 @@
 {
-  "extends": ["@remix-run/eslint-config", "@remix-run/eslint-config/node"],
-  "root": true
+  "extends": ["next/core-web-vitals", "prettier"]
 }
diff --git a/.gitignore b/.gitignore
@@ -1,6 +1,40 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
 /node_modules
-/public/build
-/.cache
-/.idea
-/.netlify
-.env
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+/test_results
+
+# next.js
+/.next/
+/out/
+
+# production
+/build
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# local env files
+.env*.local
+
+# vercel
+.vercel
+
+# typescript
+*.tsbuildinfo
+next-env.d.ts
+
+# cypress
+/cypress/screenshots
+/cypress/videos
diff --git a/.prettierignore b/.prettierignore
@@ -0,0 +1,11 @@
+.cache
+.netlify
+.next
+/netlify
+/node_modules
+/public
+
+.env
+preferences.arc
+sam.json
+sam.yaml
diff --git a/.prettierrc.json b/.prettierrc.json
@@ -1,5 +1,4 @@
 {
-    "printWidth": 120,
-    "singleQuote": true,
-    "tabWidth": 4
+  "printWidth": 120,
+  "singleQuote": true
 }
diff --git a/.stylelintignore b/.stylelintignore
@@ -1,4 +1,6 @@
 .cache
 .netlify
-node_modules
-public/build
+.next
+/netlify/
+/node_modules
+/public
diff --git a/.stylelintrc.json b/.stylelintrc.json
@@ -1,3 +1,3 @@
 {
-    "extends": ["stylelint-config-standard"]
+  "extends": ["stylelint-config-standard", "stylelint-config-prettier"]
 }
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,9 +1,15 @@
 {
-    "editor.rulers": [120],
-    "files.insertFinalNewline": true,
-    "files.trimFinalNewlines": true,
-    "files.trimTrailingWhitespace": true,
-    "yaml.schemas": {
-        "https://taskfile.dev/schema.json": ["taskfiles/dependencies.yaml", "taskfiles/tests.yaml"]
-    }
+  "editor.rulers": [120],
+  "files.insertFinalNewline": true,
+  "files.trimFinalNewlines": true,
+  "files.trimTrailingWhitespace": true,
+  "yaml.schemas": {
+    "https://taskfile.dev/schema.json": [
+      "taskfiles/dependencies.yaml",
+      "taskfiles/docker.yaml",
+      "taskfiles/run.yaml",
+      "taskfiles/setup.yaml",
+      "taskfiles/tests.yaml"
+    ]
+  }
 }
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2020 Damien Carcel
+Copyright (c) 2023 Damien Carcel
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/README.md b/README.md
@@ -2,19 +2,20 @@
 
 ## Requirements
 
--   Docker 24.0.5 or more recent
--   Docker Compose 2.20.3 or more recent
+- Docker
+- Docker Compose v2
+- Task
 
 ## How to use it?
 
-Open VS Code, and accept to open the project in Dev Containers when prompted.
-
-The, the full list of actions can be accessed by running the following command in VS Code Dev Containers terminal:
+The full list of actions can be accessed by running the following command in your usual terminal:
 
 ```bash
 $ task
 ```
 
+Optionally, if using VS Code, accept to open the project in Dev Containers when prompted.
+
 ## License
 
 This repository is under the MIT license. See the complete license in the [LICENSE](LICENSE) file.
diff --git a/TODO.md b/TODO.md
@@ -0,0 +1,2 @@
+- Migrate the existing pages to Next
+- Run the tasks directly in Dev Containers like before
diff --git a/Taskfile.yaml b/Taskfile.yaml
@@ -3,14 +3,23 @@ version: '3'
 silent: true
 
 includes:
-    dependencies:
-        taskfile: ./taskfiles/dependencies.yaml
-        aliases: [d]
-    tests:
-        taskfile: ./taskfiles/tests.yaml
-        aliases: [t]
+  setup:
+    taskfile: ./taskfiles/setup.yaml
+    aliases: [s]
+  docker:
+    taskfile: ./taskfiles/docker.yaml
+    aliases: [dc]
+  dependencies:
+    taskfile: ./taskfiles/dependencies.yaml
+    aliases: [d]
+  run:
+    taskfile: ./taskfiles/run.yaml
+    aliases: [r]
+  tests:
+    taskfile: ./taskfiles/tests.yaml
+    aliases: [t]
 
 tasks:
-    default:
-        cmds:
-            - task --list
+  default:
+    cmds:
+      - task --list