Feature/148 add linters and prettier to project

.eslintrc.cjs

@@ -0,0 +1,27 @@
+/** @type {import("eslint").Linter.Config} */
+
+import { quoteProps } from './prettier.config.cjs'
+
+// Note: this config has been migrated to eslint.config.mjs via
+// npx @eslint/migrate-config .eslintrc.json
+
+module.exports = {
+  extends: ['plugin:astro/recommended'],
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    tsconfigRootDir: __dirname,
+    sourceType: 'module',
+    ecmaVersion: 'latest'
+  },
+  overrides: [
+    {
+      files: ['*.astro'],
+      parser: 'astro-eslint-parser',
+      parserOptions: {
+        parser: '@typescript-eslint/parser',
+        extraFileExtensions: ['.astro']
+      },
+      rules: {}
+    }
+  ]
+}

.github/workflows/astro-build-and-test.yml

@@ -0,0 +1,42 @@
+name: Build and Test Astro App
+
+on:
+  pull_request:
+    types: [opened, synchronize]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [18.x, 20.x]
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Set up Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: 'npm'
+
+      - name: Cache npm modules
+        uses: actions/cache@v3
+        with:
+          path: |
+            ~/.npm
+            node_modules
+          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-node-
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Build Astro application
+        run: npm run build
+
+      - name: Test Astro application
+        run: npm run test

.husky/commit-msg

@@ -0,0 +1,3 @@
+#!/usr/bin / env sh
+
+npx commitlint --edit $1

.husky/pre-commit

@@ -0,0 +1,3 @@
+#!/usr/bin/env sh
+
+npm run test

.vscode/settings.json

@@ -0,0 +1,15 @@
+{
+  "eslint.validate": [
+    "javascript",
+    "javascriptreact",
+    "astro",
+    "typescript",
+    "typescriptreact"
+  ],
+  "prettier.documentSelectors": [
+    "**/*.astro"
+  ],
+  "[astro]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+  },
+}

README.md

@@ -53,6 +53,46 @@ The [preview](https://docs.astro.build/en/reference/cli-reference/#astro-preview
   npm run preview
 ```
 
+## Tech Stack
+
+**Client:** 
+  - [Astro](https://astro.build/)
+  - [Boostrap CSS](https://getbootstrap.com/) 
+  - [Prettier](https://prettier.io/)
+  - [TypeScript](https://www.typescriptlang.org/)
+
+**Server:** 
+ - [Node](https://nodejs.org/en)
+
+## Installation
+
+Install all the requirements with **npm install** after forking and cloning the repository
+
+```bash
+  npm install
+```
+
+## Deployment
+
+To deploy this project in a local environment, run the following 
+
+```bash
+  npm run dev
+```
+
+To build your site for deployment. run the following. By default, this will generate static files and place them in a dist/ directory. If SSR is enabled, this will generate the necessary server files to serve your site.
+
+```bash
+  npm run build
+```
+
+The [preview](https://docs.astro.build/en/reference/cli-reference/#astro-preview) command allows you to preview your site locally after building to catch any errors in your build output before deploying it by starting a local server to serve the contents of your static directory (*dist/* by default) created by running *astro build*. 
+**_The command is not designed to be run in production._**
+
+```bash
+  npm run preview
+```
+
 ## Contributing
 
 Found some important information missing? Please open a Pull Request and help improve this project. We welcome contributions of all kinds, whether it's adding new terms, fixing typos, or suggesting new features.

commitlint.config.js

@@ -0,0 +1,3 @@
+// commitlint.config.js
+
+export default { extends: ["@commitlint/config-conventional"] }

eslint.config.mjs

@@ -0,0 +1,45 @@
+import tsParser from "@typescript-eslint/parser";
+import parser from "astro-eslint-parser";
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+import js from "@eslint/js";
+import { FlatCompat } from "@eslint/eslintrc";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const compat = new FlatCompat({
+  baseDirectory: __dirname,
+  recommendedConfig: js.configs.recommended,
+  allConfig: js.configs.all,
+});
+
+export default [
+  ...compat.extends("plugin:astro/recommended"),
+  {
+    languageOptions: {
+      parser: tsParser,
+      ecmaVersion: "latest",
+      sourceType: "module",
+
+      parserOptions: {
+        tsconfigRootDir: __dirname,
+      },
+    },
+  },
+  {
+    files: ["**/*.astro"],
+
+    languageOptions: {
+      parser: parser,
+      ecmaVersion: 5,
+      sourceType: "script",
+
+      parserOptions: {
+        parser: "@typescript-eslint/parser",
+        extraFileExtensions: [".astro"],
+      },
+    },
+
+    rules: {},
+  },
+];