Merge pull request #1 from SELab-2/skeleton

Add skeleton code
SELab-2 · Feb 23, 2024 · 575f21c · 575f21c
2 parents 9059994 + df7d165
commit 575f21c
Show file tree

Hide file tree

Showing 41 changed files with 5,576 additions and 2 deletions.
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -37,8 +37,8 @@ jobs:
       - name: Run Frontend linters
         working-directory: frontend
         run: |
-          npm run dev lint
-          npm run dev format:check
+          npm run lint
+          npm run format:check
 
       - name: Run Backend linter
         run: autopep8 -rd --exit-code backend

diff --git a/backend/.flake8 b/backend/.flake8
@@ -0,0 +1,3 @@
+[flake8]
+extend-ignore = E203
+exclude = .git,__pycache__,venv
diff --git a/backend/.gitignore b/backend/.gitignore
@@ -0,0 +1,2 @@
+__pycache__
+*venv*
diff --git a/backend/README.md b/backend/README.md
@@ -0,0 +1,43 @@
+## Run the backend api
+
+### Setup
+
+#### In this directy execute the following command to create a python environment:
+
+```sh
+python -m venv venv
+```
+
+#### Activate the environment:
+
+```sh
+source venv/bin/activate
+```
+
+#### Install the dependencies:
+
+```sh
+pip install -r requirements.txt
+```
+
+### Usage
+
+#### Activate the environment:
+
+```sh
+source venv/bin/activate
+```
+
+#### Run the web server:
+
+```sh
+./run.sh
+```
+
+It will start a local development server on port `8000`
+
+#### To format the python code in place to conform to PEP 8 style:
+
+```sh
+autopep8 -ri .
+```
diff --git a/backend/app.py b/backend/app.py
@@ -0,0 +1,8 @@
+from fastapi import FastAPI
+
+app = FastAPI()
+
+
+@app.get("/api")
+async def root():
+    return {"message": "Hello World"}
diff --git a/backend/requirements.txt b/backend/requirements.txt
@@ -0,0 +1,20 @@
+annotated-types==0.6.0
+anyio==4.3.0
+autopep8==2.0.4
+click==8.1.7
+fastapi==0.109.2
+h11==0.14.0
+httptools==0.6.1
+idna==3.6
+pycodestyle==2.11.1
+pydantic==2.6.1
+pydantic_core==2.16.2
+python-dotenv==1.0.1
+PyYAML==6.0.1
+sniffio==1.3.0
+starlette==0.36.3
+typing_extensions==4.9.0
+uvicorn==0.27.1
+uvloop==0.19.0
+watchfiles==0.21.0
+websockets==12.0
diff --git a/backend/run.sh b/backend/run.sh
@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+uvicorn app:app --reload
diff --git a/frontend/.eslintrc.cjs b/frontend/.eslintrc.cjs
@@ -0,0 +1,15 @@
+/* eslint-env node */
+require('@rushstack/eslint-patch/modern-module-resolution')
+
+module.exports = {
+  root: true,
+  'extends': [
+    'plugin:vue/vue3-essential',
+    'eslint:recommended',
+    '@vue/eslint-config-typescript',
+    '@vue/eslint-config-prettier/skip-formatting'
+  ],
+  parserOptions: {
+    ecmaVersion: 'latest'
+  }
+}
diff --git a/frontend/.gitignore b/frontend/.gitignore
@@ -0,0 +1,30 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+.DS_Store
+dist
+dist-ssr
+coverage
+*.local
+
+/cypress/videos/
+/cypress/screenshots/
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
+
+*.tsbuildinfo
diff --git a/frontend/.prettierrc.json b/frontend/.prettierrc.json
@@ -0,0 +1,8 @@
+{
+  "$schema": "https://json.schemastore.org/prettierrc",
+  "semi": false,
+  "tabWidth": 2,
+  "singleQuote": true,
+  "printWidth": 100,
+  "trailingComma": "none"
+}
diff --git a/frontend/.vscode/extensions.json b/frontend/.vscode/extensions.json
@@ -0,0 +1,8 @@
+{
+  "recommendations": [
+    "Vue.volar",
+    "Vue.vscode-typescript-vue-plugin",
+    "dbaeumer.vscode-eslint",
+    "esbenp.prettier-vscode"
+  ]
+}
diff --git a/frontend/README.md b/frontend/README.md
@@ -0,0 +1,35 @@
+## Setup the frontend
+
+```sh
+npm install
+```
+
+### Compile and Hot-Reload for Development
+
+```sh
+npm run dev
+```
+
+### Type-Check, Compile and Minify for Production
+
+```sh
+npm run build
+```
+
+### Run Unit Tests with [Vitest](https://vitest.dev/)
+
+```sh
+npm run test:unit
+```
+
+### Lint with [ESLint](https://eslint.org/)
+
+```sh
+npm run lint
+```
+
+### Format with prettier
+
+```sh
+npm run format
+```
diff --git a/frontend/env.d.ts b/frontend/env.d.ts
@@ -0,0 +1 @@
+/// <reference types="vite/client" />
diff --git a/frontend/index.html b/frontend/index.html
@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8">
+    <link rel="icon" href="/favicon.ico">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>Vite App</title>
+  </head>
+  <body>
+    <div id="app"></div>
+    <script type="module" src="/src/main.ts"></script>
+  </body>
+</html>