Atomic Application

Application skeleton for Atomic Framework — start building in seconds

Packagist: globus-studio/atomic-framework-application · composer create-project globus-studio/atomic-framework-application myapp

---

Quick start

composer create-project globus-studio/atomic-framework-application myapp
cd myapp
cp .env.example .env
php atomic init/key
php -S localhost:8000 -t public

Or clone directly:

git clone https://github.com/MADEVAL/Atomic-Framework-Application.git myapp
cd myapp
composer install
cp .env.example .env
php atomic init/key
php -S localhost:8000 -t public

Open http://localhost:8000 — you should see the Atomic welcome page.

---

What's included

Directory	Purpose
app/	Application code — controllers, models, middleware, auth provider
bootstrap/	App initialization — constants, config loader, error handling
config/	Configuration files — database, cache, mail, auth, queue
routes/	Route definitions — web.php, api.php, cli.php
public/	Web root — entry point, themes, uploads
database/	Migrations and seeds
resources/	View templates
storage/	Logs, cache, sessions

Bundled examples:

File	Description
app/Http/Controllers/HomeController.php	Landing page controller
app/Http/Controllers/DashboardController.php	Protected dashboard (requires auth)
app/Http/Controllers/AuthController.php	Login, register, logout
app/Http/Middleware/Authenticate.php	Auth guard middleware
app/Http/Models/User.php	User model (uuid, email, password, role)
app/Auth/UserProvider.php	Database-backed user provider
database/migrations/create_users_table.php	Users table migration

---

Requirements

Requirement	Notes
PHP ≥ 8.1	Required extensions: json, session, mbstring, fileinfo, pdo, pdo_mysql, curl
MySQL / MariaDB	Primary database
Redis	Recommended — cache, queues, sessions, WebSockets
Composer	Dependency manager

---

Common commands

php atomic init                  # Scaffold project structure
php atomic init/key              # Generate app encryption keys
php atomic migrations/migrate    # Run database migrations
php atomic queue/worker          # Start queue worker
php atomic schedule/run          # Execute due tasks
php atomic routes                # List all registered routes

---

Links

Resource	URL
Framework	globus-studio/atomic-framework
Framework repo	MADEVAL/Atomic-Framework
Skeleton repo	MADEVAL/Atomic-Framework-Application
Documentation	docs/

---

License

GPL-3.0-or-later. See LICENSE.