Merge pull request #188 from fsr5-fhaachen/dev

Dev

.env.example

@@ -1,10 +1,11 @@
 APP_NAME="Erstiwoche FB5"
 APP_ENV=local
-APP_KEY=base64:+XGltHl7EIuTEflDKyIa4XKq/p5zjrU65nhakvHakf4=
+APP_KEY=
 APP_DEBUG=true
 APP_URL=http://localhost
 
 TUTOR_PASSWORD=password
+ADMIN_PASSWORD=admin
 
 LOG_CHANNEL=stack
 LOG_LEVEL=debug

.github/workflows/php.yml → .github/workflows/ci.yml

@@ -1,4 +1,4 @@
-name: PHP CI
+name: CI
 
 on:
   push:
@@ -16,24 +16,32 @@ jobs:
         node-version: [16.x]
 
     steps:
+      - name: Checkout
+        uses: actions/checkout@v3
       - name: Use PHP ${{ matrix.php-version }}
-        uses: shivammathur/setup-php@16011a795d747d5f45038f96371c3b98aec5669d
+        uses: shivammathur/setup-php@v2
         with:
           php-version: ${{ matrix.php-version }}
-      - uses: actions/checkout@v3
-      - name: Copy .env
-        run: php -r "file_exists('.env') || copy('.env.example', '.env');"
-      - name: Install Dependencies
-        run: composer update --ignore-platform-req=php+ --no-interaction --no-progress
       - name: Use Node.js ${{ matrix.node-version }}
         uses: actions/[email protected]
         with:
           node-version: ${{ matrix.node-version }}
           cache: "npm"
-      - name: Install Dependencies
+      - name: Copy .env
+        run: php -r "file_exists('.env') || copy('.env.example', '.env');"
+      - name: Install PHP Dependencies
+        run: composer update --ignore-platform-req=php+ --no-interaction --no-progress
+      - name: Install Node.js Dependencies
         run: |
           npm ci
-      - run: npm run build --if-present
+      - name: Execute Node.js linting
+        run: |
+           npm run lint
+      - name: Execute PHP linting
+        run: |
+          php artisan fixer:fix --dry-run -vvv
+      - name: Execute build
+        run: npm run build --if-present
       - name: Generate key
         run: php artisan key:generate
       - name: Directory Permissions

.gitignore

@@ -1,3 +1,10 @@
+# app files
+tutors.csv
+
+# dev files
+laravel.sql
+.php-cs-fixer.cache
+
 # Created by https://www.toptal.com/developers/gitignore/api/node,phpunit,laravel,visualstudiocode,jetbrains+all,windows,macos,linux,git
 # Edit at https://www.toptal.com/developers/gitignore?templates=node,phpunit,laravel,visualstudiocode,jetbrains+all,windows,macos,linux,git
 

.prettierrc.json

@@ -0,0 +1 @@
+{}

.vscode/extensions.json

@@ -1,3 +1,10 @@
 {
-  "recommendations": ["vue.volar"]
+  "recommendations": [
+    "vue.volar",
+    "esbenp.prettier-vscode",
+    "mike-co.import-sorter",
+    "bradlc.vscode-tailwindcss",
+    "gruntfuggly.todo-tree",
+    "junstyle.php-cs-fixer"
+  ]
 }

.vscode/settings.json

@@ -1,9 +1,30 @@
 {
-  "editor.tabSize": 2,
-  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "editor.formatOnSave": true,
   "importSorter.generalConfiguration.sortOnBeforeSave": true,
-  "todo-tree.filtering.excludeGlobs": [
-    "**/node_modules",
-    "**/node_modules/**"
-  ]
+  "importSorter.importStringConfiguration.maximumNumberOfImportExpressionsPerLine.type": "newLineEachExpressionAfterCountLimitExceptIfOnlyOne",
+  "importSorter.importStringConfiguration.maximumNumberOfImportExpressionsPerLine.count": 80,
+  "importSorter.importStringConfiguration.tabSize": 2,
+  "importSorter.importStringConfiguration.quoteMark": "double",
+  "[javascript]": {
+    "editor.tabSize": 2,
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[typescript]": {
+    "editor.tabSize": 2,
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[vue]": {
+    "editor.tabSize": 2,
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[json]": {
+    "editor.tabSize": 2,
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[php]": {
+    "editor.tabSize": 4,
+    "editor.defaultFormatter": "bmewburn.vscode-intelephense-client"
+  },
+  "php-cs-fixer.executablePath": "${workspaceFolder}/vendor/bin/php-cs-fixer",
+  "php-cs-fixer.config": ".php-cs-fixer.php",
 }

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 FH-Aachen FSR5
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,3 +1,147 @@
-# groups
+<h1 align="center">Welcome to portals 👋</h1>
+<p>
+  <a href="https://github.com/fsr5-fhaachen/portals/blob/main/LICENSE" target="_blank">
+    <img alt="License: MIT" src="https://img.shields.io/github/license/fsr5-fhaachen/portals" />
+  </a>
+  <a href="https://twitter.com/fsr5_fhaachen" target="_blank">
+    <img alt="Twitter: fsr5_fhaachen" src="https://img.shields.io/twitter/follow/fsr5_fhaachen.svg?style=social" />
+  </a>
+</p>
 
-ToDo
+> Group allocation tool for the first week of the Department of Electrical Engineering and Information Technology at the FH Aachen - University of Applied Sciences.
+
+## main
+
+<a href="https://github.com/fsr5-fhaachen/portals/actions/workflows/ci.yml" target="_blank">
+  <img alt="CI" src="https://github.com/fsr5-fhaachen/portals/actions/workflows/ci.yml/badge.svg" />
+</a>
+
+## dev
+
+<a href="https://github.com/fsr5-fhaachen/portals/actions/workflows/ci.yml" target="_blank">
+  <img alt="CI dev" src="https://github.com/fsr5-fhaachen/portals/actions/workflows/ci.yml/badge.svg?branch=dev" />
+</a>
+
+## Install
+
+Clone the repository and install the dependencies:
+
+```sh
+git clone [email protected]:fsr5-fhaachen/portals.git
+cd portals
+npm install
+composer install
+```
+
+Copy .env.example to .env and fill in the database credentials.
+
+```sh
+cp .env.example .env
+```
+
+Generate the application key:
+
+```sh
+php artisan key:generate
+```
+
+Run the migrations:
+
+```sh
+php artisan migrate
+```
+
+## Usage
+
+### development
+
+For development, you can use the built-in PHP server:
+
+```sh
+php artisan serve
+```
+
+and the vite dev server:
+
+```sh
+npm run dev
+```
+
+### type generation
+
+To generate the typescript types for the frontend, run:
+
+```sh
+php artisan typescript:generate
+```
+
+### linting
+
+You can lint the code with the following commands:
+
+```sh
+npm run lint
+php artisan fixer:fix --dry-run -vvv
+```
+
+and try to fix the errors with:
+
+```sh
+npm run lint:fix
+php artisan fixer:fix -vvv
+```
+
+### testing
+
+You can run the tests with:
+
+```sh
+vendor/bin/phpunit
+```
+
+### build
+
+You can build the application with:
+
+```sh
+npm run build
+```
+
+## Authors
+
+👤 **Titus Kirch (main author)**
+
+- Website: https://tkirch.dev/
+- LinkedIn: [Titus Kirch](https://www.linkedin.com/in/tituskirch/)
+- Twitter: [@TitusKirch](https://twitter.com/TitusKirch)
+- Github: [@TitusKirch](https://github.com/TitusKirch)
+
+👤 **Benedikt Haas (main author)**
+
+- LinkedIn: [Benedikt Haas](https://www.linkedin.com/in/benedikt-haas-ab698924a/)
+- Github: [@BenediktHaas96](https://github.com/BenediktHaas96)
+
+👤 **Simon Ostendorf**
+
+- LinkedIn: [Simon Ostendorf](https://www.linkedin.com/in/simonostendorf/)
+- Github: [@simonostendorf](https://github.com/simonostendorf)
+
+👤 **Patrik Schmolke**
+
+- LinkedIn: [Patrik Schmolke](https://www.linkedin.com/in/patrik-schmolke-612962175/)
+- Github: [@Rec0gnice](https://github.com/Rec0gnice)
+
+Show here to see the full list of [contributors](https://github.com/fsr5-fhaachen/portals/graphs/contributors) who participated in this project.
+
+## 🤝 Contributing
+
+Contributions, issues and feature requests are welcome!<br />Feel free to check [issues page](https://github.com/fsr5-fhaachen/portals/issues).
+
+## Show your support
+
+Give a ⭐️ if this project helped you!
+
+## 📝 License
+
+Copyright © 2022 [fsr5-fhaachen](https://github.com/fsr5-fhaachen).<br />
+This project is [MIT](https://github.com/fsr5-fhaachen/portals/blob/main/LICENSE) licensed.