init commit

Author: bumblecoder

.gitignore

@@ -0,0 +1 @@
+.idea

Makefile

@@ -0,0 +1,21 @@
+DOCKER_COMPOSE=docker compose
+UP_SERVICE=$(DOCKER_COMPOSE) build --no-cache && $(DOCKER_COMPOSE) up -d && sleep 5
+RESTART_SERVICE=$(DOCKER_COMPOSE) restart
+EXEC_PHP_FPM=$(DOCKER_COMPOSE) exec php-fpm
+COMPOSER=bash -c "composer install" && sleep 5
+SEED=bash -c "php artisan migrate --force"
+
+all: help
+build: ## Build and deploy project from scratch
+	@echo "Build and bootstrap project..."
+	$(UP_SERVICE)
+	$(EXEC_PHP_FPM) $(COMPOSER)
+	$(EXEC_PHP_FPM) $(SEED)
+composer:  ## Install/update/delete composer libraries
+	@echo "Running composer..."
+	$(EXEC_PHP_FPM) $(COMPOSER)
+down: ## Shut down project but keep mysql db data
+	@echo "Shutting down project..."
+	$(DOCKER_COMPOSE) down --remove-orphans
+help:
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'

README.md

@@ -0,0 +1,90 @@
+<div align="center">
+<h3 align="center">TechTest Laravel Application</h3>
+  <a href="https://github.com/othneildrew/Best-README-Template">
+    <img src="https://d15ywwv3do91l7.cloudfront.net/medium.webp" alt="Logo" width="80" height="80">
+  </a>  
+  <p align="center">
+    <br />
+    <a href="http://ec2-54-185-223-128.us-west-2.compute.amazonaws.com" target="_blank">View Demo</a>
+  </p>
+</div>
+
+<!-- ABOUT THE PROJECT -->
+## About The Project
+
+[![Product Name Screen Shot][product-screenshot]](http://ec2-54-185-223-128.us-west-2.compute.amazonaws.com/)
+
+This repository contains a Dockerized Laravel application designed for local development. The cloud setup and deployment (AWS EC2, RDS, S3, CloudFront) were performed manually to save time. For the local environment, this setup provides a quick way to spin up and showcase the test assignment.
+
+**Note**: My primary framework is Symfony, but for this test assignment, I opted to use Laravel as specified in the requirements.
+
+<!-- GETTING STARTED -->
+## Getting Started
+
+### Prerequisites
+
+Ensure you have Docker and Docker Compose installed on your machine.
+
+### Setup and Build
+
+1. Clone the repo
+   ```sh
+   git clone https://github.com/bumblecoder/tech-task.git
+   cd tech-task
+   cp code/.env.example code/.env
+   ```
+2. Build and start the Docker containers:
+   ```sh
+   make build
+   ```
+   This command will build and start the necessary Docker containers. The process may take some time.
+   
+3. Create the stored procedure:
+   ```sh
+   make run-sql
+   ```
+   This will execute the SQL script to set up the stored procedure in the MySQL container.
+
+4. Access the application:
+   
+   By default, the application will be available on port 80 of localhost. Ensure this port is available; otherwise, the build may fail.
+
+   Open your browser and go to http://localhost. 
+
+## AWS Test Environment
+
+The application is also deployed on an AWS test environment for one week from the submission of the test assignment. After this period, the test environment will be removed.
+**AWS EC2 Instance URL:**
+
+http://ec2-54-185-223-128.us-west-2.compute.amazonaws.com
+
+AWS services used for deployment:
+
+- EC2 (Elastic Compute Cloud)
+- RDS (Relational Database Service)
+- S3 (Simple Storage Service)
+- CloudFront (Content Delivery Network)
+- Configuration of Security Groups
+
+## API Endpoints
+
+The following API endpoints are available:
+
+- GET /api/articles — Retrieve a list of all articles
+- POST /api/articles — Create a new article
+- GET /api/articles/{id} — Retrieve an article by ID
+- PUT|PATCH /api/articles/{id} — Update an article by ID
+- DELETE /api/articles/{id} — Delete an article by ID
+
+## Tests
+![image](https://github.com/user-attachments/assets/f4c96200-52b7-45de-b640-abe5d86ccaa3)
+
+
+<!-- LICENSE -->
+## License
+
+Distributed under the MIT License.
+
+<!-- MARKDOWN LINKS & IMAGES -->
+<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
+[product-screenshot]: https://d15ywwv3do91l7.cloudfront.net/project_screenshot.png

code/.editorconfig

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

code/.env.example

@@ -0,0 +1,68 @@
+APP_NAME=Laravel
+APP_ENV=local
+APP_KEY=
+APP_DEBUG=true
+APP_TIMEZONE=UTC
+APP_URL=http://localhost
+
+APP_LOCALE=en
+APP_FALLBACK_LOCALE=en
+APP_FAKER_LOCALE=en_US
+
+APP_MAINTENANCE_DRIVER=file
+# APP_MAINTENANCE_STORE=database
+
+PHP_CLI_SERVER_WORKERS=4
+
+BCRYPT_ROUNDS=12
+
+LOG_CHANNEL=stack
+LOG_STACK=single
+LOG_DEPRECATIONS_CHANNEL=null
+LOG_LEVEL=debug
+
+DB_CONNECTION=sqlite
+# DB_HOST=127.0.0.1
+# DB_PORT=3306
+# DB_DATABASE=laravel
+# DB_USERNAME=root
+# DB_PASSWORD=
+
+SESSION_DRIVER=database
+SESSION_LIFETIME=120
+SESSION_ENCRYPT=false
+SESSION_PATH=/
+SESSION_DOMAIN=null
+
+BROADCAST_CONNECTION=log
+FILESYSTEM_DISK=local
+QUEUE_CONNECTION=database
+
+CACHE_STORE=database
+CACHE_PREFIX=
+
+MEMCACHED_HOST=127.0.0.1
+
+REDIS_CLIENT=phpredis
+REDIS_HOST=127.0.0.1
+REDIS_PASSWORD=null
+REDIS_PORT=6379
+
+MAIL_MAILER=log
+MAIL_HOST=127.0.0.1
+MAIL_PORT=2525
+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_APP_NAME="${APP_NAME}"
+
+TRANSACTION_DEVIATION=10

code/.gitattributes

@@ -0,0 +1,11 @@
+* text=auto eol=lf
+
+*.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

code/.gitignore

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

code/README.md

@@ -0,0 +1,66 @@
+<p align="center"><a href="https://laravel.com" target="_blank"><img src="https://raw.githubusercontent.com/laravel/art/master/logo-lockup/5%20SVG/2%20CMYK/1%20Full%20Color/laravel-logolockup-cmyk-red.svg" width="400" alt="Laravel Logo"></a></p>
+
+<p align="center">
+<a href="https://github.com/laravel/framework/actions"><img src="https://github.com/laravel/framework/workflows/tests/badge.svg" alt="Build Status"></a>
+<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/dt/laravel/framework" alt="Total Downloads"></a>
+<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/v/laravel/framework" alt="Latest Stable Version"></a>
+<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/l/laravel/framework" alt="License"></a>
+</p>
+
+## About Laravel
+
+Laravel is a web application framework with expressive, elegant syntax. We believe development must be an enjoyable and creative experience to be truly fulfilling. Laravel takes the pain out of development by easing common tasks used in many web projects, such as:
+
+- [Simple, fast routing engine](https://laravel.com/docs/routing).
+- [Powerful dependency injection container](https://laravel.com/docs/container).
+- Multiple back-ends for [session](https://laravel.com/docs/session) and [cache](https://laravel.com/docs/cache) storage.
+- Expressive, intuitive [database ORM](https://laravel.com/docs/eloquent).
+- Database agnostic [schema migrations](https://laravel.com/docs/migrations).
+- [Robust background job processing](https://laravel.com/docs/queues).
+- [Real-time event broadcasting](https://laravel.com/docs/broadcasting).
+
+Laravel is accessible, powerful, and provides tools required for large, robust applications.
+
+## Learning Laravel
+
+Laravel has the most extensive and thorough [documentation](https://laravel.com/docs) and video tutorial library of all modern web application frameworks, making it a breeze to get started with the framework.
+
+You may also try the [Laravel Bootcamp](https://bootcamp.laravel.com), where you will be guided through building a modern Laravel application from scratch.
+
+If you don't feel like reading, [Laracasts](https://laracasts.com) can help. Laracasts contains thousands of video tutorials on a range of topics including Laravel, modern PHP, unit testing, and JavaScript. Boost your skills by digging into our comprehensive video library.
+
+## Laravel Sponsors
+
+We would like to extend our thanks to the following sponsors for funding Laravel development. If you are interested in becoming a sponsor, please visit the [Laravel Partners program](https://partners.laravel.com).
+
+### Premium Partners
+
+- **[Vehikl](https://vehikl.com/)**
+- **[Tighten Co.](https://tighten.co)**
+- **[WebReinvent](https://webreinvent.com/)**
+- **[Kirschbaum Development Group](https://kirschbaumdevelopment.com)**
+- **[64 Robots](https://64robots.com)**
+- **[Curotec](https://www.curotec.com/services/technologies/laravel/)**
+- **[Cyber-Duck](https://cyber-duck.co.uk)**
+- **[DevSquad](https://devsquad.com/hire-laravel-developers)**
+- **[Jump24](https://jump24.co.uk)**
+- **[Redberry](https://redberry.international/laravel/)**
+- **[Active Logic](https://activelogic.com)**
+- **[byte5](https://byte5.de)**
+- **[OP.GG](https://op.gg)**
+
+## Contributing
+
+Thank you for considering contributing to the Laravel framework! The contribution guide can be found in the [Laravel documentation](https://laravel.com/docs/contributions).
+
+## Code of Conduct
+
+In order to ensure that the Laravel community is welcoming to all, please review and abide by the [Code of Conduct](https://laravel.com/docs/contributions#code-of-conduct).
+
+## Security Vulnerabilities
+
+If you discover a security vulnerability within Laravel, please send an e-mail to Taylor Otwell via [[email protected]](mailto:[email protected]). All security vulnerabilities will be promptly addressed.
+
+## License
+
+The Laravel framework is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).

code/artisan

@@ -0,0 +1,15 @@
+#!/usr/bin/env php
+<?php
+
+use Symfony\Component\Console\Input\ArgvInput;
+
+define('LARAVEL_START', microtime(true));
+
+// Register the Composer autoloader...
+require __DIR__.'/vendor/autoload.php';
+
+// Bootstrap Laravel and handle the command...
+$status = (require_once __DIR__.'/bootstrap/app.php')
+    ->handleCommand(new ArgvInput);
+
+exit($status);

code/bootstrap/app.php

@@ -0,0 +1,18 @@
+<?php
+
+use Illuminate\Foundation\Application;
+use Illuminate\Foundation\Configuration\Exceptions;
+use Illuminate\Foundation\Configuration\Middleware;
+
+return Application::configure(basePath: dirname(__DIR__))
+    ->withRouting(
+        web: __DIR__.'/../routes/web.php',
+        commands: __DIR__.'/../routes/console.php',
+        health: '/up',
+    )
+    ->withMiddleware(function (Middleware $middleware) {
+        //
+    })
+    ->withExceptions(function (Exceptions $exceptions) {
+        //
+    })->create();