Project setup (#1)

Add initial project

Author: frankdekker

.editorconfig

@@ -0,0 +1,18 @@
+; This file is for unifying the coding style for different editors and IDEs.
+; More information at http://editorconfig.org
+
+root = true
+
+[*]
+charset = utf-8
+indent_size = 4
+indent_style = space
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false
+
+[*.{yml, neon}]
+indent_size = 2

.gitattributes

@@ -0,0 +1,67 @@
+# Text file attributes
+# - `text` Treat as text
+# - `eol=lf` Set line endings to LF
+# - `whitespace` Set whitespace properties
+#   - `blank-at-eol` Treats trailing whitespaces at the end of a line as an error
+#   - `blank-at-eof`Treat blank lines added at the end of file as an error
+#   - `space-before-tab` Treat a space character that appears immediately before a tab character in the initial indent part of the line as an error
+#   - `tab-in-indent` Treats a tab character in the initial indent part of the line as an error
+# - `tabwidth` Tells how many character positions a tab occupies
+# - `diff=html` & `diff=php` Diff is shown using the specified diff driver.
+*.css          text eol=lf whitespace=blank-at-eol,-blank-at-eof,-space-before-tab,tab-in-indent,tabwidth=4
+*.html         text eol=lf whitespace=blank-at-eol,-blank-at-eof,-space-before-tab,tab-in-indent,tabwidth=4 diff=html
+*.js           text eol=lf whitespace=blank-at-eol,-blank-at-eof,-space-before-tab,tab-in-indent,tabwidth=4
+*.json         text eol=lf whitespace=blank-at-eol,-blank-at-eof,-space-before-tab,tab-in-indent,tabwidth=4
+*.lock         text eol=lf whitespace=blank-at-eol,-blank-at-eof,-space-before-tab,tab-in-indent,tabwidth=4
+*.php          text eol=lf whitespace=blank-at-eol,-blank-at-eof,-space-before-tab,tab-in-indent,tabwidth=4 diff=php
+*.scss         text eol=lf whitespace=blank-at-eol,-blank-at-eof,-space-before-tab,tab-in-indent,tabwidth=4
+*.sh           text eol=lf whitespace=blank-at-eol,-blank-at-eof,-space-before-tab,tab-in-indent,tabwidth=4 diff=php
+*.sql          text eol=lf whitespace=blank-at-eol,-blank-at-eof,-space-before-tab,tab-in-indent,tabwidth=4
+*.svg          text eol=lf whitespace=blank-at-eol,-blank-at-eof,-space-before-tab,tab-in-indent,tabwidth=4
+*.ts           text eol=lf whitespace=blank-at-eol,-blank-at-eof,-space-before-tab,tab-in-indent,tabwidth=4
+*.twig         text eol=lf whitespace=blank-at-eol,-blank-at-eof,-space-before-tab,tab-in-indent,tabwidth=4
+*.txt          text eol=lf whitespace=blank-at-eol,-blank-at-eof,-space-before-tab,tab-in-indent,tabwidth=4
+*.xml          text eol=lf whitespace=blank-at-eol,-blank-at-eof,-space-before-tab,tab-in-indent,tabwidth=4
+*.xml.dist     text eol=lf whitespace=blank-at-eol,-blank-at-eof,-space-before-tab,tab-in-indent,tabwidth=4
+*.xsd          text eol=lf whitespace=blank-at-eol,-blank-at-eof,-space-before-tab,tab-in-indent,tabwidth=4
+.editorconfig  text eol=lf whitespace=blank-at-eol,-blank-at-eof,-space-before-tab,tab-in-indent,tabwidth=4
+.env.*         text eol=lf whitespace=blank-at-eol,-blank-at-eof,-space-before-tab,tab-in-indent,tabwidth=4
+.eslintignore  text eol=lf whitespace=blank-at-eol,-blank-at-eof,-space-before-tab,tab-in-indent,tabwidth=4
+.eslintrc      text eol=lf whitespace=blank-at-eol,-blank-at-eof,-space-before-tab,tab-in-indent,tabwidth=4
+.gitattributes text eol=lf whitespace=blank-at-eol,-blank-at-eof,-space-before-tab,tab-in-indent,tabwidth=4
+.gitignore     text eol=lf whitespace=blank-at-eol,-blank-at-eof,-space-before-tab,tab-in-indent,tabwidth=4
+.gitkeep       text eol=lf whitespace=blank-at-eol,-blank-at-eof,-space-before-tab,tab-in-indent,tabwidth=4
+.htaccess      text eol=lf whitespace=blank-at-eol,-blank-at-eof,-space-before-tab,tab-in-indent,tabwidth=4
+
+*.md           text eol=lf whitespace=-blank-at-eol,-blank-at-eof,-space-before-tab,tab-in-indent,tabwidth=4
+
+*.neon         text eol=lf whitespace=blank-at-eol,-blank-at-eof,-space-before-tab,tab-in-indent,tabwidth=2
+*.yaml         text eol=lf whitespace=blank-at-eol,-blank-at-eof,-space-before-tab,tab-in-indent,tabwidth=2
+*.yml          text eol=lf whitespace=blank-at-eol,-blank-at-eof,-space-before-tab,tab-in-indent,tabwidth=2
+
+# Binary file attributes
+# - `-text` Treat as binary file
+# - `diff` Include binary diff in patches instead of "binary files differ."
+*.gif     -text diff
+*.gz      -text diff
+*.ico     -text diff
+*.jpeg    -text diff
+*.jpg     -text diff
+*.phar    -text diff
+*.png     -text diff
+*.svgz    -text diff
+*.ttf     -text diff
+*.woff    -text diff
+*.woff2   -text diff
+
+# Exclude directories/files from composer vendor package
+/dev export-ignore
+/frontend export-ignore
+/tests export-ignore
+/.* export-ignore
+/*.sh export-ignore
+/php*.json export-ignore
+/php*.xml export-ignore
+/php*.dist export-ignore
+/php*.neon export-ignore
+/renovate.json export-ignore

.github/workflows/test.yml

@@ -0,0 +1,113 @@
+name: Run checks
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    name: PHP ${{ matrix.php-versions }} - Test ${{ matrix.composer-flags }}
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        php-versions: [ '8.1', '8.2', '8.3' ]
+        composer-flags: [ '', '--prefer-lowest' ]
+        exclude:
+          - php-versions: 8.3
+            composer-flags: ''
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-versions }}
+          coverage: none
+
+      - name: Validate composer.json and composer.lock
+        run: composer validate
+
+      - name: Install dependencies
+        run: composer update --prefer-dist --no-progress --no-suggest --prefer-stable ${{ matrix.composer-flags }}
+
+      - name: Run test suite
+        run: composer test
+
+  coverage:
+    name: PHP 8.3 - Test with coverage
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 8.3
+          coverage: pcov
+
+      - name: Install dependencies
+        run: composer update --prefer-dist --no-progress --no-suggest --prefer-stable
+
+      - name: Run test suite
+        run: php -dpcov.enabled=1 -dpcov.exclude="~vendor~" vendor/bin/phpunit --testsuite unit,integration --coverage-clover ./.coverage/coverage.xml
+
+      - name: Check coverage
+        run: test ! -f ./.coverage/coverage.xml || php vendor/bin/phpfci inspect ./.coverage/coverage.xml --exit-code-on-failure --reportText
+
+  php-quality:
+    name: PHP quality checks
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 8.1
+          coverage: none
+
+      - name: Install dependencies
+        run: composer install --prefer-dist --no-progress --no-suggest
+
+      - name: run checks
+        run: composer check
+
+  ts-quality:
+    name: Typescript quality checks
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Use Node.js 21.x
+        uses: actions/setup-node@v3
+        with:
+          node-version: 21.x
+
+      - name: Install dependencies
+        run: cd frontend && npm install
+
+      - name: Run eslint
+        run: cd frontend && npm run lint
+
+  build-assets-check:
+    name: Check build assets
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Use Node.js 21.x
+        uses: actions/setup-node@v3
+        with:
+          node-version: 21.x
+
+      - name: Install dependencies
+        run: cd frontend && npm install
+
+      - name: Build assets
+        run: cd frontend && npm run build
+
+      - name: Git diff - expecting no changes
+        run: git status | grep "nothing to commit, working tree clean"

.gitignore

@@ -0,0 +1,7 @@
+/.idea
+/vendor
+/composer.lock
+/phpunit.xml
+/.phpunit.result.cache
+/dev/public/bundles
+/dev/var

CONTRIBUTING.md

@@ -0,0 +1,46 @@
+# Contributing
+ 
+Contributions are **welcome** and will be fully **credited**.
+ 
+We accept contributions via Pull Requests on [Github](https://github.com/).
+ 
+ 
+## Pull Requests
+ 
+- **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - The easiest way to apply the conventions is to install [PHP Code Sniffer](http://pear.php.net/package/PHP_CodeSniffer).
+ 
+- **Add tests!** - Your patch won't be accepted if it doesn't have tests.
+ 
+- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
+ 
+- **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.
+ 
+- **Create feature branches** - Don't ask us to pull from your master branch.
+ 
+- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
+ 
+## Development
+
+### Requirements
+- [docker >= 20.10](https://docs.docker.com/engine/install/)
+- [docker compose plugin](https://docs.docker.com/compose/install/linux/)
+
+### Getting started
+A minimal Symfony project has been setup under `/dev/`. To start development, in the root of the project:
+
+```bash
+./start.sh [--port <nr>]
+```
+
+After the containers are up and running, the project is available at http://localhost:8888.
+
+> **_NOTE:_**  the nodejs container will automatically rebuild the frontend assets and deploy them in the `/public/` directory
+
+> **_NOTE:_**  When making changes to the frontend, ensure committing the compiled assets.  
+ 
+## Running tests and code style checks
+ 
+``` bash
+composer check
+composer test
+```

README.md

@@ -1,2 +1,71 @@
-# symfony-log-viewer-bundle
-A log viewer for Symfony
+[![Minimum PHP Version](https://img.shields.io/badge/php-%3E%3D%208.1-8892BF)](https://php.net/)
+[![Minimum Symfony Version](https://img.shields.io/badge/symfony-%3E%3D%206.0-brightgreen)](https://symfony.com/doc/current/validation.html)
+![Run tests](https://github.com/frankdekker/symfony-log-viewer-bundle/actions/workflows/test.yml/badge.svg)
+
+<div style="text-align: center">
+<h1 style="margin-bottom:0">Log viewer for Symfony</h1>
+<i>Inspired by <a href="https://github.com/opcodesio/log-viewer">opcodesio/log-viewer</a></i>
+<img src="docs/images/preview.png" alt="log-viewer">
+</div>
+
+ **Log Viewer**: a bundle for your [Symfony](https://symfony.com/) app. It provides a user-friendly UI to read, filter and search log files.
+
+Out of the box it will read your Monolog logs in the `var/log` directory, but can be configured to
+read logs from any directory.
+
+
+### Features
+
+- 📂 **View all the Monolog logs** in your `%kernel.logs_dir%` directory,
+- 🔍 **Search** the logs,
+- 🎚 **Filter** by log level (error, info, debug, etc.), or by channel.
+- 🌑 **Dark mode**,
+- 💾 **Download** or **delete** log files from the UI,
+- ☎️ **API access** for folders, files & log entries,
+
+## Getting started
+
+### Requirements
+
+- **PHP 8.1+**
+- **Symfony 6.0+ or 7.0+**
+
+### Installation
+
+Use [composer](https://getcomposer.org/).
+```bash
+composer require fdekker/log-viewer-bundle
+```
+If you don't use Symfony Flex, you'll need to manually enable the bundle:
+```php
+# /config/bundles.php
+return [
+    // ...
+    FD\LogViewer\FdLogViewerBundle::class => ['all' => true],
+];
+```
+And add the route by creating file `/config/routes/fd_log_viewer.php`:
+```php
+<?php
+use Symfony\Component\Routing\Loader\Configurator\RoutingConfigurator;
+
+return static function (RoutingConfigurator $routingConfigurator): void {
+    $routingConfigurator->import('.', 'fd_symfony_log_viewer')->prefix('/log-viewer');
+};
+```
+
+After installing the package, publish the front-end assets by running:
+```bash
+php bin/console assets:install
+```
+
+### Usage
+
+Once the installation is complete, you will be able to access **Log Viewer** directly in your browser.
+
+By default, the application is available at: `{APP_URL}/log-viewer`.
+
+(for example: `https://my-app.test/log-viewer`)
+
+## Configuration
+- [Adjust default configuration](docs/configuration.md)