Merge pull request #85 from Kovah/dev

v0.0.28

.env.docker

@@ -8,30 +8,16 @@ COMPOSE_PROJECT_NAME=LinkAce
 APP_URL=http://localhost
 # The environment is usually 'production' but may be changed to 'local' for development
 APP_ENV=local
-# The app key is generated whily running the setup and should NOT be changed later
+# The app key is generated later, please leave it blank
 APP_KEY=
 # Enable the debug more if you are running into issues or while developing
 APP_DEBUG=true
 # Set to true, if you are using a proxy that terminates SSL. Required to get the correct URLs for LinkAce
 FORCE_HTTPS=false
-
-## Configuration of the database connection
-# Set the database driver (mysql, )
-DB_CONNECTION=mysql
-# Set the host of your database here
-DB_HOST=db
-# Set the port of your database here
-DB_PORT=3306
-# Set the database name here
-DB_DATABASE=linkace
-# Set both username and password of the user accessing the database
-DB_USERNAME=linkace
-DB_PASSWORD=changeThisPassword
-
-## Configure user session details
 # Set the time after a session expires automatically, in minutes. Default is 7 days.
 SESSION_LIFETIME=10080
 
+
 ## Backup configuration
 # Enable backups here
 BACKUP_ENABLED=false
@@ -45,27 +31,50 @@ BACKUP_NOTIFICATION_EMAIL=your@email.com
 # Maximum size of the backups in megabytes
 BACKUP_MAX_SIZE=512
 
+
+## Amazon Web Services (AWS) S3 configuration
+# Define the key ID, the access key, the region and your bucket name here if you want to use AWS S3 for backups
+AWS_ACCESS_KEY_ID=
+AWS_SECRET_ACCESS_KEY=
+AWS_DEFAULT_REGION=us-east-1
+AWS_BUCKET=
+
+
 ## Mail configuration
+# Set the driver used for sending email here, default is `smtp`
 MAIL_DRIVER=smtp
+# Set the SMTP host and its port here
 MAIL_HOST=smtp.mailtrap.io
 MAIL_PORT=2525
+# Set the username used to connect to the SMTP server here
 MAIL_USERNAME=null
+# Set the password used to connect to the SMTP server here
 MAIL_PASSWORD=null
+# If your SMTP server uses encrypted connections, enable it here by setting the variable to `tls`
 MAIL_ENCRYPTION=null
 
-## Amazon Web Services (AWS) S3 configuration
-# Define the key ID, the access key, the region and your bucket name here if you want to use AWS S3 for backups
-AWS_ACCESS_KEY_ID=
-AWS_SECRET_ACCESS_KEY=
-AWS_DEFAULT_REGION=us-east-1
-AWS_BUCKET=
+
+## Configuration of the database connection
+# Set the database driver (mysql, )
+DB_CONNECTION=mysql
+# Set the host of your database here
+DB_HOST=db
+# Set the port of your database here
+DB_PORT=3306
+# Set the database name here
+DB_DATABASE=linkace
+# Set both username and password of the user accessing the database
+DB_USERNAME=linkace
+DB_PASSWORD=changeThisPassword
+
 
 ## Redis cache configuration
 # Set the Redis connection here if you want to use it
 REDIS_HOST=redis
 REDIS_PASSWORD=changeThisPassword
 REDIS_PORT=6379
 
+
 ## You probably do not want to change any values blow. Only continue if you know what you are doing.
 # Configure various driver
 SESSION_DRIVER=redis

.env.example

@@ -7,28 +7,16 @@ APP_NAME=LinkAce
 APP_URL=http://localhost
 # The environment is usually 'production' but may be changed to 'local' for development
 APP_ENV=local
-# The app key is generated whily running the setup and should NOT be changed later
+# The app key is generated later, please leave it blank
 APP_KEY=
 # Enable the debug more if you are running into issues or while developing
 APP_DEBUG=true
-
-## Configuration of the database connection
-# Set the database driver (mysql, )
-DB_CONNECTION=mysql
-# Set the host of your database here
-DB_HOST=127.0.0.1
-# Set the port of your database here
-DB_PORT=3306
-# Set the database name here
-DB_DATABASE=linkace
-# Set both username and password of the user accessing the database
-DB_USERNAME=linkace
-DB_PASSWORD=changeThisPassword
-
-## Configure user session details
+# Indicates that the setup was completed and the app can be used now
+SETUP_COMPLETED=false
 # Set the time after a session expires automatically, in minutes. Default is 7 days.
 SESSION_LIFETIME=10080
 
+
 ## Backup configuration
 # Enable backups here
 BACKUP_ENABLED=false
@@ -37,32 +25,56 @@ BACKUP_ENABLED=false
 BACKUP_DISK=cloud
 # Set to false if you do not want to be notified about successful or broken backups
 BACKUP_NOTIFICATIONS=true
-# The notification email may be used to get backup notifications
+# The notification email may be used to get backup notifications, Mail must be configured for this to work!
 BACKUP_NOTIFICATION_EMAIL=your@email.com
 # Maximum size of the backups in megabytes
 BACKUP_MAX_SIZE=512
 
+
+## Amazon Web Services (AWS) S3 configuration
+# Define the key ID, the access key, the region and your bucket name here if you want to use AWS S3 for backups
+AWS_ACCESS_KEY_ID=
+AWS_SECRET_ACCESS_KEY=
+AWS_DEFAULT_REGION=us-east-1
+AWS_BUCKET=
+
+
 ## Mail configuration
+# Set the driver used for sending email here, default is `smtp`
 MAIL_DRIVER=smtp
+# Set the SMTP host and its port here
 MAIL_HOST=smtp.mailtrap.io
 MAIL_PORT=2525
+# Set the username used to connect to the SMTP server here
 MAIL_USERNAME=null
+# Set the password used to connect to the SMTP server here
 MAIL_PASSWORD=null
+# If your SMTP server uses encrypted connections, enable it here by setting the variable to `tls`
 MAIL_ENCRYPTION=null
 
-## Amazon Web Services (AWS) S3 configuration
-# Define the key ID, the access key, the region and your bucket name here if you want to use AWS S3 for backups
-AWS_ACCESS_KEY_ID=
-AWS_SECRET_ACCESS_KEY=
-AWS_DEFAULT_REGION=us-east-1
-AWS_BUCKET=
+
+## Configuration of the database connection
+## Those settings are configured during the setup, please do not modify them now
+# Set the database driver (mysql, )
+DB_CONNECTION=mysql
+# Set the host of your database here
+DB_HOST=127.0.0.1
+# Set the port of your database here
+DB_PORT=3306
+# Set the database name here
+DB_DATABASE=linkace
+# Set both username and password of the user accessing the database
+DB_USERNAME=linkace
+DB_PASSWORD=changeThisPassword
+
 
 ## Redis cache configuration
 # Set the Redis connection here if you want to use it
 REDIS_HOST=127.0.0.1
 REDIS_PASSWORD=changeThisPassword
 REDIS_PORT=6379
 
+
 ## You probably do not want to change any values blow. Only continue if you know what you are doing.
 # Configure various driver
 SESSION_DRIVER=file

.github/workflows/test.yml

@@ -0,0 +1,49 @@
+name: PHP Lint & Test
+
+on:
+  pull_request:
+
+jobs:
+  lint-test:
+    runs-on: ${{ matrix.operating-system }}
+    strategy:
+      matrix:
+        operating-system: [ubuntu-latest]
+        php-versions: ['7.2', '7.3', '7.4']
+
+    name: PHP ${{ matrix.php-versions }} Test on ${{ matrix.operating-system }}
+
+    steps:
+      - uses: actions/checkout@v1
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v1
+        with:
+          php-version: ${{ matrix.php-versions }}
+          extensions: mbstring
+
+      - name: Get Composer Cache Directory
+        id: composer-cache
+        run: echo "::set-output name=dir::$(composer config cache-files-dir)"
+
+      - name: Cache dependencies
+        uses: actions/cache@v1
+        with:
+          path: ${{ steps.composer-cache.outputs.dir }}
+          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
+          restore-keys: ${{ runner.os }}-composer-
+
+      - name: Prepare the environment
+        run: cp .env.example .env
+
+      - name: Validate composer.json and composer.lock
+        run: composer validate
+
+      - name: Install dependencies
+        run: composer install --prefer-dist --no-progress --no-suggest
+
+      - name: Run PHP CS
+        run: composer run lint
+
+      - name: Run PHPunit
+        run: composer run test

.nvmrc

@@ -1 +1 @@
-10.15.0
+12.13.1