feat: Add client (#28)

Author: thomaspoignant

.github/workflows/ci-client.yaml

@@ -1,4 +1,4 @@
-name: "Build"
+name: "CI Client"
 on:
   push:
     branches:
@@ -16,4 +16,45 @@ jobs:
         uses: actions/checkout@v4
         with:
           fetch-depth: 1
-      - run: echo "CI is running"
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 22.x
+      - run: make build-client
+  Lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 1
+      - uses: actions/setup-node@v4
+      - run: make lint-client
+
+  Test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 1
+      - uses: actions/setup-node@v4
+      - run: make test-client
+
+  Coverage:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 1
+      - uses: actions/setup-node@v4
+      - run: make coverage-client
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v5
+        with:
+          fail_ci_if_error: true
+          token: ${{ secrets.CODECOV_TOKEN }}
+          flags: client
+          working-directory: client
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

.github/workflows/ci-server.yaml

@@ -70,6 +70,7 @@ jobs:
           flags: server
           fail_ci_if_error: true
           token: ${{ secrets.CODECOV_TOKEN }}
+          flags: server
         env:
           CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
 

Makefile

@@ -14,14 +14,17 @@ RESET  := $(shell tput -Txterm sgr0)
 
 all: help
 ## Build:
-build: build-api ## Build all the binaries and put the output in out/bin/
+build: build-server build-client## Build all the binaries and put the output in out/bin/
 
 create-out-dir:
 	mkdir -p out/bin
 
-build-server: create-out-dir ## Build the migration cli in out/bin/
+build-server: create-out-dir ## Build the flag-management-api in out/bin/
 	CGO_ENABLED=0 GO111MODULE=on $(GOCMD) build -mod vendor -o out/bin/flag-management-api .
 
+build-client: ## Build the react app
+	cd client && npm install && npm run build
+
 clean: ## Remove build related file
 	-rm -fr ./bin ./out ./release
 	-rm -f ./junit-report.xml checkstyle-report.xml ./coverage.xml ./profile.cov yamllint-checkstyle.xml
@@ -42,23 +45,35 @@ setup-env:
 	sleep 2
 	migrate -source "file://database_migration" -database "postgres://goff-user:my-secret-pw@localhost:5432/gofeatureflag?sslmode=disable" up
 
+start-local: setup-env## Start the server locally
+	$(GOCMD) run -mod vendor main.go --mode=development --postgresConnectionString="postgres://goff-user:my-secret-pw@localhost:5432/gofeatureflag?sslmode=disable"
+
 ## Test:
 test: test-server
-test-server: ## Run the tests of the project
+test-server: ## Run the tests of the server project
 	$(GOTEST) -v -tags=docker -race ./...
 
+test-client: ## Run the tests of the client project
+	cd client && npm install && npm run test
+
 ## Coverage:
 coverage: coverage-server ## Run all the coverage on your project
 coverage-server: ## Run the tests of the project and export the coverage
 	$(GOTEST) -cover -covermode=count -tags=docker -coverprofile=coverage.cov ./...
 
+coverage-client: ## Run the tests of the project and export the coverage
+	cd client && npm install && npm run coverage
+
 ## Lint:
-lint: lint-server ## Run all the linters on your project
+lint: lint-server lint-client ## Run all the linters on your project
 lint-server: ## Use golintci-lint on your project
 	mkdir -p ./bin
 	curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s latest # Install linters
 	./bin/golangci-lint run --timeout=5m --timeout=5m ./... --enable-only=gci --fix # Run linters
 
+lint-client: ## Use linter to lint website
+	cd client && npm install && npm run lint
+
 ## Help:
 help: ## Show this help.
 	@echo ''

client/.eslintrc.cjs

@@ -0,0 +1,56 @@
+module.exports = {
+  root: true,
+  env: { browser: true, es2020: true },
+  parserOptions: {
+    ecmaVersion: "latest",
+    sourceType: "module",
+    project: ["./tsconfig.json", "./tsconfig.node.json"],
+    tsconfigRootDir: __dirname,
+  },
+  extends: [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/strict",
+    "plugin:@typescript-eslint/stylistic-type-checked",
+    "plugin:react-hooks/recommended",
+    "plugin:react/jsx-runtime",
+    "plugin:prettier/recommended",
+    "plugin:react/recommended",
+    "plugin:react-hooks/recommended",
+    "plugin:tailwindcss/recommended",
+  ],
+  ignorePatterns: ["dist", ".eslintrc.cjs"],
+  parser: "@typescript-eslint/parser",
+  plugins: ["react-refresh", "testing-library", "tailwindcss"],
+  rules: {
+    "react/react-in-jsx-scope": "off",
+    "react/jsx-uses-react": "off",
+    "@typescript-eslint/consistent-type-imports": "error",
+    "react/no-unescaped-entities": "off",
+    "react-refresh/only-export-components": [
+      "warn",
+      { allowConstantExport: true },
+    ],
+    "tailwindcss/classnames-order": [
+      "error",
+      {
+        callees: ["classnames"],
+        config: "tailwind.config.js",
+      },
+    ],
+    "tailwindcss/no-custom-classname": [
+      "error",
+      {
+        config: "tailwind.config.js",
+      },
+    ],
+    "testing-library/await-async-queries": "error",
+    "testing-library/no-await-sync-queries": "error",
+    "testing-library/no-debugging-utils": "warn",
+    "testing-library/no-dom-import": "off",
+  },
+  settings: {
+    react: {
+      version: "detect",
+    },
+  },
+};

client/.gitignore

@@ -0,0 +1,28 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
+
+type-check.tsbuildinfo
+coverage/
+dist/

client/.prettierrc

@@ -0,0 +1,7 @@
+{
+  "plugins": [
+    "prettier-plugin-organize-imports",
+    "prettier-plugin-tailwindcss"
+  ],
+  "trailingComma": "all"
+}

client/README.md

@@ -1,3 +1,30 @@
-# Client
+# React + TypeScript + Vite
 
-Here we will have the client code.
+This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
+
+Currently, two official plugins are available:
+
+- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
+- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
+
+## Expanding the ESLint configuration
+
+If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:
+
+- Configure the top-level `parserOptions` property like this:
+
+```js
+export default {
+  // other rules...
+  parserOptions: {
+    ecmaVersion: "latest",
+    sourceType: "module",
+    project: ["./tsconfig.json", "./tsconfig.node.json"],
+    tsconfigRootDir: __dirname,
+  },
+};
+```
+
+- Replace `plugin:@typescript-eslint/recommended` to `plugin:@typescript-eslint/recommended-type-checked` or `plugin:@typescript-eslint/strict-type-checked`
+- Optionally add `plugin:@typescript-eslint/stylistic-type-checked`
+- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and add `plugin:react/recommended` & `plugin:react/jsx-runtime` to the `extends` list

client/index.html

@@ -0,0 +1,16 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <style>
+      @import url('https://fonts.googleapis.com/css2?family=Poppins:wght@100;200;400&display=swap');
+    </style>
+    <link rel="icon" type="image/svg+xml" href="/gofeatureflag.svg" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>GO Feature Flag</title>
+  </head>
+  <body class="bg-gray-50 dark:bg-gray-900">
+    <div id="root"></div>
+    <script type="module" src="/src/main.tsx"></script>
+  </body>
+</html>