initial commit

Author: alexjustesen

.dockerignore

@@ -0,0 +1,16 @@
+/node_modules
+/public/build
+/public/hot
+/public/storage
+/storage/*.key
+/vendor
+.env
+.env.backup
+.phpunit.result.cache
+Homestead.json
+Homestead.yaml
+auth.json
+npm-debug.log
+yarn-error.log
+/.idea
+/.vscode

.editorconfig

@@ -0,0 +1,18 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 4
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false
+
+[*.{yml,yaml}]
+indent_size = 2
+
+[docker-compose.yml]
+indent_size = 4

.env.docker

@@ -0,0 +1,39 @@
+APP_NAME="Speedtest Tracker"
+APP_ENV=production
+APP_KEY=
+APP_DEBUG=false
+APP_URL=http://localhost
+
+LOG_CHANNEL=stderr
+LOG_DEPRECATIONS_CHANNEL=null
+LOG_LEVEL=debug
+
+BROADCAST_DRIVER=log
+CACHE_DRIVER=file
+FILESYSTEM_DISK=local
+QUEUE_CONNECTION=database
+SESSION_DRIVER=file
+SESSION_LIFETIME=120
+
+MEMCACHED_HOST=127.0.0.1
+
+MAIL_MAILER=smtp
+MAIL_HOST=mailhog
+MAIL_PORT=1025
+MAIL_USERNAME=null
+MAIL_PASSWORD=null
+MAIL_ENCRYPTION=null
+MAIL_FROM_ADDRESS="[email protected]"
+MAIL_FROM_NAME="${APP_NAME}"
+
+AWS_ACCESS_KEY_ID=
+AWS_SECRET_ACCESS_KEY=
+AWS_DEFAULT_REGION=us-east-1
+AWS_BUCKET=
+AWS_USE_PATH_STYLE_ENDPOINT=false
+
+VITE_PUSHER_APP_KEY="${PUSHER_APP_KEY}"
+VITE_PUSHER_HOST="${PUSHER_HOST}"
+VITE_PUSHER_PORT="${PUSHER_PORT}"
+VITE_PUSHER_SCHEME="${PUSHER_SCHEME}"
+VITE_PUSHER_APP_CLUSTER="${PUSHER_APP_CLUSTER}"

.env.example

@@ -0,0 +1,58 @@
+APP_NAME="Speedtest Tracker"
+APP_ENV=local
+APP_KEY=
+APP_DEBUG=true
+APP_URL=http://localhost
+
+LOG_CHANNEL=stack
+LOG_DEPRECATIONS_CHANNEL=null
+LOG_LEVEL=debug
+
+DB_CONNECTION=mysql
+DB_HOST=127.0.0.1
+DB_PORT=3306
+DB_DATABASE=speedtest_tracker
+DB_USERNAME=root
+DB_PASSWORD=
+
+BROADCAST_DRIVER=log
+CACHE_DRIVER=file
+FILESYSTEM_DISK=local
+QUEUE_CONNECTION=sync
+SESSION_DRIVER=file
+SESSION_LIFETIME=120
+
+MEMCACHED_HOST=127.0.0.1
+
+REDIS_HOST=127.0.0.1
+REDIS_PASSWORD=null
+REDIS_PORT=6379
+
+MAIL_MAILER=smtp
+MAIL_HOST=mailhog
+MAIL_PORT=1025
+MAIL_USERNAME=null
+MAIL_PASSWORD=null
+MAIL_ENCRYPTION=null
+MAIL_FROM_ADDRESS="[email protected]"
+MAIL_FROM_NAME="${APP_NAME}"
+
+AWS_ACCESS_KEY_ID=
+AWS_SECRET_ACCESS_KEY=
+AWS_DEFAULT_REGION=us-east-1
+AWS_BUCKET=
+AWS_USE_PATH_STYLE_ENDPOINT=false
+
+PUSHER_APP_ID=
+PUSHER_APP_KEY=
+PUSHER_APP_SECRET=
+PUSHER_HOST=
+PUSHER_PORT=443
+PUSHER_SCHEME=https
+PUSHER_APP_CLUSTER=mt1
+
+VITE_PUSHER_APP_KEY="${PUSHER_APP_KEY}"
+VITE_PUSHER_HOST="${PUSHER_HOST}"
+VITE_PUSHER_PORT="${PUSHER_PORT}"
+VITE_PUSHER_SCHEME="${PUSHER_SCHEME}"
+VITE_PUSHER_APP_CLUSTER="${PUSHER_APP_CLUSTER}"

.gitattributes

@@ -0,0 +1,11 @@
+* text=auto
+
+*.blade.php diff=html
+*.css diff=css
+*.html diff=html
+*.md diff=markdown
+*.php diff=php
+
+/.github export-ignore
+CHANGELOG.md export-ignore
+.styleci.yml export-ignore

.gitignore

@@ -0,0 +1,16 @@
+/node_modules
+/public/build
+/public/hot
+/public/storage
+/storage/*.key
+/vendor
+.env
+.env.backup
+.phpunit.result.cache
+Homestead.json
+Homestead.yaml
+auth.json
+npm-debug.log
+yarn-error.log
+/.idea
+/.vscode

Dockerfile

@@ -0,0 +1,35 @@
+FROM serversideup/php:8.1-fpm-nginx
+
+# Install addition packages
+RUN apt-get update && apt-get install -y \
+    cron \
+    supervisor \
+    php8.1-bcmath \
+    php8.1-pgsql \
+    && apt-get clean \
+    && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/* /usr/share/doc/* \
+    && rm -f /etc/cont-init.d/50-laravel-automations
+
+# Install Speedtest cli
+RUN curl -s https://packagecloud.io/install/repositories/ookla/speedtest-cli/script.deb.sh | bash \
+    && apt-get install -y speedtest
+
+# Copy package configs
+COPY docker/deploy/cron/scheduler /etc/cron.d/scheduler
+COPY docker/deploy/entrypoint /usr/local/bin/entrypoint
+COPY docker/deploy/etc/cont-init.d/ /etc/cont-init.d/
+COPY docker/deploy/supervisord.conf /etc/supervisor/conf.d/supervisord.conf
+
+RUN chmod 0644 /etc/cron.d/scheduler \
+    && crontab /etc/cron.d/scheduler \
+    && chmod +x /usr/local/bin/entrypoint
+
+# Copy app
+COPY . /var/www/html
+COPY .env.docker .env
+
+# Install app dependencies
+RUN composer install --no-interaction --prefer-dist --optimize-autoloader --no-dev \
+    && chown -R 9999:9999 /var/www/html
+
+ENTRYPOINT ["entrypoint"]

README.md

@@ -0,0 +1,85 @@
+## Speedtest Tracker
+
+Welcome to Speedtest Tracker! Speedtest Tracker runs a speedtest check against Ookla's Speedtest service on a schedule.
+
+This project replaces https://github.com/henrywhitaker3/Speedtest-Tracker as it looks like this project has been abandoned https://github.com/henrywhitaker3/Speedtest-Tracker/issues/1013.
+
+### Roadmap
+To suggest features please use the roadmap. You can also follow development progress there as well: https://speedtest-tracker-roadmap.alexjustesen.dev/
+
+
+### Deployment
+
+#### Docker w/ sqlite
+```bash
+docker run -itd --name speedtest-tracker \
+    -p 8080:80 \
+    -e "PHP_POOL_NAME=speedtest-tracker_php" \
+    -e "DB_CONNECTION=sqlite" \
+    -e "DB_DATABASE=/appdata/database.sqlite" \
+    -v speedtest-tracker_app:/appdata \
+    speedtest-tracker
+```
+
+#### Docker w/ MariaDB or MySQL
+```bash
+docker run -itd --name speedtest-tracker \
+    -p 8080:80 \
+    -e "PHP_POOL_NAME=speedtest-tracker_php" \
+    -e "DB_CONNECTION=mysql" \
+    -e "DB_HOST=mysql" \
+    -e "DB_PORT=3306" \
+    -e "DB_DATABASE=speedtest_tracker" \
+    -e "DB_USERNAME=" \
+    -e "DB_PASSWORD=" \
+    speedtest-tracker
+```
+
+#### Docker Compose
+```bash
+# tbd...
+```
+
+
+### Build Docker Image
+Want to build the image locally? Cool, just clone the repo and go right ahead...
+
+```bash
+docker build . -t speedtest-tracker
+```
+
+#### Runing the docker image
+```bash
+docker run -it -p 8080:80 \
+    speedtest-tracker
+```
+
+### Development
+
+Since this project uses Laravel as our framework of choice we can take advantage of [Laravel Sail](https://laravel.com/docs/9.x/sail) for a development environment.
+
+#### Clone the repo
+
+```bash
+gh repo clone alexjustesen/speedtest-tracker \
+    && cd speedtest-tracker \
+    && cp .env.example .env
+```
+
+#### Install composer dependencies
+```bash
+docker run --rm \
+    -u "$(id -u):$(id -g)" \
+    -v $(pwd):/var/www/html \
+    -w /var/www/html \
+    laravelsail/php81-composer:latest \
+    composer install --ignore-platform-reqs
+```
+
+#### Start sail
+```bash
+./vendor/bin/sail up -d
+
+# or, if you have the sail bash alias
+sail up -d
+```

app/Console/Commands/AppStartupCommand.php

@@ -0,0 +1,107 @@
+<?php
+
+namespace App\Console\Commands;
+
+use Illuminate\Console\Command;
+use Illuminate\Support\Facades\Artisan;
+use Illuminate\Support\Facades\Log;
+use Illuminate\Support\Facades\Storage;
+use Symfony\Component\Process\Process;
+
+class AppStartupCommand extends Command
+{
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'app:startup';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Runs when the app is started to make sure everything is ok';
+
+    /**
+     * Execute the console command.
+     *
+     * @return int
+     */
+    public function handle()
+    {
+        $this->info('🐇 Starting up Speedtest Tracker...');
+        $this->newLine();
+
+        $this->clearAppCache();
+
+        // $this->checkAppKey();
+
+        // $this->checkAppDatabase();
+
+        // $this->migrateDatabase();
+
+        $this->line('🚀 Speedtest Tracker is ready to roll!');
+
+        return 0;
+    }
+
+    private function checkAppDatabase()
+    {
+        if (! Storage::exists('database.sqlite')) {
+            $this->line('🙄 Database not found, creating a new one...');
+
+            $process = new Process(['touch', 'storage/app/database.sqlite']);
+            $process->run();
+
+            if (! Storage::exists('database.sqlite')) {
+                $this->error('❌ There was an issue creating the database, check the logs');
+            }
+
+            $this->line('✅ done');
+            $this->newLine();
+        }
+    }
+
+    private function checkAppKey()
+    {
+        if (blank(config('app.key'))) {
+            $this->line('🔑 Generating a key...');
+
+            Artisan::call('key:generate');
+
+            $this->line('✅ done');
+            $this->newLine();
+        }
+    }
+
+    private function clearAppCache()
+    {
+        $this->line('💵 Clearing the cache...');
+
+        Artisan::call('optimize');
+
+        $this->line('✅ done');
+        $this->newLine();
+    }
+
+    private function migrateDatabase()
+    {
+        $this->line('⏳ Migrating the database...');
+
+        try {
+            Artisan::call('migrate', [
+                '--database' => 'sqlite',
+                '--force' => true,
+            ]);
+        } catch (\Throwable $th) {
+            $this->error('❌ There was an issue migrating the database, check the logs');
+
+            Log::info($th);
+        }
+
+        $this->line('✅ done');
+        $this->newLine();
+    }
+}