PHPackages winningsoftware/symfony-base - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Framework](/categories/framework) 4. / 5. winningsoftware/symfony-base ActiveProject[Framework](/categories/framework) winningsoftware/symfony-base ============================ A base Symfony 7.3 project template with Latte + Vue 2.3.6(1mo ago)07↓89.1%GPL-3.0-or-laterPHPPHP >=8.4CI passing Since Oct 18Pushed 3w agoCompare [ Source](https://github.com/WinningSoftwareDev/symfony-base)[ Packagist](https://packagist.org/packages/winningsoftware/symfony-base)[ RSS](/packages/winningsoftware-symfony-base/feed)WikiDiscussions main Synced 3w ago READMEChangelog (8)Dependencies (58)Versions (30)Used By (0) Symfony Base Template ===================== [](#symfony-base-template) [![Version 3.1.1](https://camo.githubusercontent.com/47eff36cdb5b0e63a5b26a384648069af08cbd0398d8bedd45d566fbdcdf4a59/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f56657273696f6e2d332e312e312d626c7565)](https://camo.githubusercontent.com/47eff36cdb5b0e63a5b26a384648069af08cbd0398d8bedd45d566fbdcdf4a59/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f56657273696f6e2d332e312e312d626c7565)[![License GPL-3.0-or-later](https://camo.githubusercontent.com/1f081152ea1147a9fac48726615f330f4a74ce18c28d10e42bf4f62b9ecb6009/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4c6963656e73652d47504c2d2d332e302d2d6f722d2d6c617465722d343061646263)](https://camo.githubusercontent.com/1f081152ea1147a9fac48726615f330f4a74ce18c28d10e42bf4f62b9ecb6009/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4c6963656e73652d47504c2d2d332e302d2d6f722d2d6c617465722d343061646263)[![Symfony 8.0.13](https://camo.githubusercontent.com/2cfe5cd7a0638d20cd7e3fc8ee21ed47dc772552b5f3432810acb0022ae8209b/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f53796d666f6e792d382e302e31332d626c61636b3f6c6f676f3d73796d666f6e79)](https://camo.githubusercontent.com/2cfe5cd7a0638d20cd7e3fc8ee21ed47dc772552b5f3432810acb0022ae8209b/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f53796d666f6e792d382e302e31332d626c61636b3f6c6f676f3d73796d666f6e79) A **highly opinionated**, production-ready Symfony 8 starter template designed for rapid application development with a modern frontend stack. πŸš€ Features ---------- [](#-features) - **Core:** Symfony 8 + Doctrine ORM/DBAL. - **Templating:** [Latte](https://latte.nette.org/) β€” with custom Vite integration for **Instant Live-Reload**. - **Frontend:** Vue.js 3, Vite, TailwindCSS, TypeScript, and SCSS. - **Auth System:** Full "out-of-the-box" flow (Login, Registration, Password Reset, Email Verification, OAuth). - **Email Builder:** A database-driven utility for generating templated HTML emails. - **Quality Gates:** Pre-configured PHPStan (Max Level), PHP-CS-Fixer, and ESLint. [![index.png](screenshots/index.png)](screenshots/index.png)[![authentication.png](screenshots/authentication.png)](screenshots/authentication.png)[![user-overview.png](screenshots/user-overview.png)](screenshots/user-overview.png)[![error-page.png](screenshots/error-page.png)](screenshots/error-page.png) πŸ›  Installation -------------- [](#-installation) ### Create your project [](#create-your-project) ``` composer create-project winningsoftware/symfony-base my-project ``` This will download the Symfony Base project to a new "my-project" directory in your current working directory. This also runs the installer as part of the post create project command which creates the required directories, copies the relevant config files, cleans up unnecessary files and runs `composer install` - so you don't need to run this manually. ### Configure your environment [](#configure-your-environment) Update your `.env` file to suit your application/development environment. See the "Environment Configuration" section below. ### Install JavaScript dependencies [](#install-javascript-dependencies) ``` npm install ``` ### Database initialisation [](#database-initialisation) Check the script at `data/setup.sql` to see what SQL will be executed by the following command: ``` php bin/console app:database:setup # Or manually import data/setup.sql ``` βš™οΈ Environment Configuration ---------------------------- [](#️-environment-configuration) Before running the app, update your `.env` file with the following key variables: VariableDefault / ExampleDescription`APP_NAME``My App`The name of your application`DEFAULT_URI``http://localhost`Used for generating absolute URLs and OAuth redirect URLs`DB_HOST``localhost`Database host (use `mysql` if using Docker)`DB_PORT``3306`Database port`DB_USER``root`Database user`DB_PASSWORD``docker`Database password`ADMIN_USER``admin@my-app.com`Default admin email (created by `app:database:setup`)`ADMIN_PASSWORD``noodlepot`Default admin password`MAILER_DSN``smtp://mailcatcher:1025`SMTP connection string`MAIL_FROM_NAME`β€”Sender name for outgoing emails`MAIL_FROM_ADDRESS``info@my-app.com`Sender address for outgoing emails`VITE_SERVER_PORT``3000`Vite dev server port`VITE_LOCAL_PORT``3000`Local port mapped to Vite server (e.g. in Docker)`USE_HMR``false`Set to `true` to enable Vite Hot Module Replacement`OAUTH_GITHUB_CLIENT_ID`β€”GitHub OAuth App client ID`OAUTH_GITHUB_CLIENT_SECRET`β€”GitHub OAuth App client secret`OAUTH_GOOGLE_CLIENT_ID`β€”Google OAuth 2.0 client ID`OAUTH_GOOGLE_CLIENT_SECRET`β€”Google OAuth 2.0 client secret> **Note**: The OAuth redirect URL is constructed from your `DEFAULT_URI` env var. Ensure `DEFAULT_URI` uses the correct scheme (`https` in production) so the redirect URL matches what you registered with the provider. ### Obtaining OAuth Credentials [](#obtaining-oauth-credentials) #### GitHub [](#github) 1. Go to **Settings > Developer settings > [OAuth Apps](https://github.com/settings/developers)** and click **New OAuth App**. 2. Fill in: - **Application name:** Your app name - **Homepage URL:** Your app's URL (e.g. `https://my-app.com`) - **Authorization callback URL:** `https://my-app.com/connect/github/check` 3. Click **Register application**. 4. Copy the **Client ID** and generate a **Client Secret**. Set them as `OAUTH_GITHUB_CLIENT_ID` and `OAUTH_GITHUB_CLIENT_SECRET` in your `.env`. #### Google [](#google) 1. Go to the [Google Cloud Console](https://console.cloud.google.com/), create or select a project. 2. Navigate to **APIs & Services > [Credentials](https://console.cloud.google.com/apis/credentials)**. 3. Click **Create Credentials > OAuth client ID**. 4. Set **Application type** to **Web application**, add your callback URL under **Authorized redirect URIs**: `https://my-app.com/connect/google/check`. 5. Click **Create**. Copy the **Client ID** and **Client Secret**. Set them as `OAUTH_GOOGLE_CLIENT_ID` and `OAUTH_GOOGLE_CLIENT_SECRET` in your `.env`. πŸ’» Development Workflow ---------------------- [](#-development-workflow) This template supports both local and containerized development. Choose the method that fits your environment. ### 1. Running the Project (Local) [](#1-running-the-project-local) The simplest way to get started is using PHP's built-in server: - **Terminal A (PHP):** `php -S localhost:8000 -t public/` - **Terminal B (Vite):** `npm run vite:dev` - **Config:** Set `USE_HMR=true` and `DEFAULT_URI=http://localhost` in your `.env`. ### 2. Docker Setup (Recommended) [](#2-docker-setup-recommended) For a production-like environment, I recommend using **Docker**. A standard setup should include: - **PHP-FPM** (8.4+) - **Server (Nginx/Apache/Caddy etc)** - **MySQL 8.0+** - **Mailcatcher/Mailtrap** (for local email testing) > If using a custom Docker setup with an HTTPS reverse proxy, use the commented-out `server` block in `vite.config.ts`to map your certificates and enable `wss` for HMR. You will need to manually copy the certificate and key from your reverse proxy container into the referenced locations in your PHP container. ### 3. Hot Module Replacement (HMR) [](#3-hot-module-replacement-hmr) HMR is configured for both Vue/SCSS assets and Latte templates. - **Local Dev:** The default `server` block in `vite.config.ts` works out of the box. - **Containerized Dev:** If running over plain HTTP in Docker, ensure `server.https` is `false` and `server.hmr.protocol`is set to `ws`. ### 4. Quality Control [](#4-quality-control) Run these commands before committing to maintain high standards: ToolCommandDescription**PHPStan**`composer stan`Static analysis (Level: Max)**PHP-CS-Fixer**`composer cs`Check coding standards (dry-run)**ESLint**`npm run lint`Lint Vue and TypeScript filesπŸ“‚ Project Structure ------------------- [](#-project-structure) This template uses a modular, domain-oriented structure. The `src/` directory handles PHP logic, while `assets/scripts/`organizes Vue components and frontend utilities into feature-based plugins. ``` src/ β”œβ”€β”€ Administration/ # Module: Admin panel (Vue SPA) β€” controllers & API β”œβ”€β”€ Application/ # Domain: Where you build your app logic β”œβ”€β”€ Authentication/ # Module: Self-contained User & Security logic β”œβ”€β”€ Core/ # Internal: Base classes and framework extensions └── Kernel.php assets/ β”œβ”€β”€ scripts/ β”‚ β”œβ”€β”€ Core/ # Frontend utilities (ComponentLoader, FlashHandler) β”‚ β”œβ”€β”€ Plugin/ β”‚ β”‚ β”œβ”€β”€ AppCore/ # Homepage UI (IntroCard and sub-components) β”‚ β”‚ └── AuthCore/ # Authentication UI components β”‚ └── app.ts # Main JS entry point └── styles/ # CSS and Tailwind directives ``` πŸ—„ Database Schema ----------------- [](#-database-schema) This project uses a **multi-schema approach** to maintain strict separation between the Authentication system and other areas of your application. The `php bin/console app:database:setup` command executes `data/setup.sql`, which creates the following: - **`Authentication` Schema**: Contains `tblUser`, `tblEmailVerificationToken`, `tblPasswordResetToken`, `tblRole`, `tblPermission`, `tblRolePermission`, `tblUserRole`, and `tblUserOauth`. - **`Core` Schema**: Contains `ublEmailType` and `ublOauthProvider` (look-up tables). > **IMPORTANT**: Before running the setup command, review `data/setup.sql`. If your database user does not have `CREATE SCHEMA`permissions, or if you prefer a different database setup, you will need to modify this script and the corresponding Doctrine Entity mappings. You'll need to expose the relevant port (3000 by default) from your PHP container. πŸ“§ Email System -------------- [](#-email-system) The built-in `EmailBuilder` utility allows you to generate emails by referencing a "Handle" stored in the `Core.ublEmailType` table. **Example Usage:** ``` $email = $this->emailBuilder->getEmail( EmailType::VERIFY_EMAIL_ADDRESS, $user->getEmail(), [ 'verificationUrl' => $this->generateUrl('authenticate_verify_email', ['token' => $token]), ] ); $this->mailer->send($email); ``` πŸ›£ Available Routes ------------------ [](#-available-routes) NamespaceNameMethodPath**App\\Application**`app_index``GET``/`**App\\Authentication**`authenticate``GET``/authenticate`**App\\Authentication**`authenticate_request_password_reset``GET`,`POST``/authenticate/password-reset`**App\\Authentication**`authenticate_password_reset``GET`,`POST``/authenticate/password-reset/reset`**App\\Authentication**`authenticate_login``GET`,`POST``/authenticate/login`**App\\Authentication**`authenticate_logout``GET``/authenticate/logout`**App\\Authentication**`authenticate_get_logged_in_user``GET``/authenticate/current-user`**App\\Authentication**`authenticate_register``POST``/authenticate/register`**App\\Authentication**`authenticate_verify_email``GET``/authenticate/verify`**App\\Authentication**`authenticate_resend_verification_email``POST``/authenticate/resend-verification-email`**App\\Authentication**`user_account``GET``/user/account`**App\\Authentication**`connect_oauth_start``GET``/connect/{service}`**App\\Authentication**`connect_github_check``GET``/connect/github/check`**App\\Authentication**`connect_google_check``GET``/connect/google/check`**App\\Administration**`admin_entry``ANY``/admin/{vue_routing}`**Liip Monitor**`liip_monitor_health_interface``ANY``/monitor/health/`> Run `php bin/console debug:router` for the full list of included endpoints. πŸ”§ Customizing ------------- [](#-customizing) - **Homepage:** The main entry point is defined in `src/Application/IndexController.php` with the template at `templates/application/index.latte`. This template renders a single `IntroCard` Vue component, which acts as a wrapper for various internal components. You can find and modify these in `assets/scripts/Plugin/AppCore`. - **Authentication:** All backend logic resides in `src/Authentication`. This includes Login, Registration, Password Reset, and Email Verification. - **Auth UI:** For the frontend side of the built-in system, this project uses Vue components found in the `assets/scripts/Plugin/AuthCore` directory. - **OAuth Providers:** To add or remove OAuth sign-in options, update the `Core.ublOauthProvider` seed data in `data/setup.sql`, create a `KnpU\OAuth2ClientBundle` client config in `config/packages/knpu_oauth2_client.yaml`, register the callback route in `config/routes.yaml`, and add the provider entry to the `OAUTH_PROVIDERS` array in `assets/scripts/Plugin/AuthCore/Constant/OauthProvider.ts`. - **Styles:** Global styles, Tailwind directives, and SCSS variables are managed in `assets/styles/app.css`. 🐳 Docker & Advanced Setup ----------------------------- [](#-docker--advanced-setup) The recommended approach for a production-like environment is a containerized setup (PHP, Nginx, MySQL, and Mailcatcher). If you are using a custom Docker setup, ensure you update the `server` block in `vite.config.ts` to use the commented out section. If you're using plain HTTP inside your containers, remove `server.https` and set `server.hmr.protocol` to `ws`. ### Health Score 46 β€” FairBetter than 92% of packages Maintenance95 Actively maintained with recent releases Popularity6 Limited adoption so far Community6 Small or concentrated contributor base Maturity64 Established project with proven stability Bus Factor1 Top contributor holds 100% of commits β€” single point of failure How is this calculated?**Maintenance (25%)** β€” Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** β€” Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** β€” Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** β€” Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~11 days Recently: every ~0 days Total 20 Last Release 35d ago Major Versions 0.5.0 β†’ 1.0.02025-11-18 1.0.0 β†’ 2.0.02026-03-28 PHP version history (3 changes)0.1.0PHP >=8.2 0.3.0PHP >=8.3 2.3.5PHP >=8.4 ### Community Maintainers ![](https://www.gravatar.com/avatar/4fc3e409f69482d5d7086543302c56c39012286928d59891666111383987a121?d=identicon)[WinningSoftware](/maintainers/WinningSoftware) --- Top Contributors [![DanielWinning](https://avatars.githubusercontent.com/u/71671373?v=4)](https://github.com/DanielWinning "DanielWinning (240 commits)") ### Code Quality Static AnalysisPHPStan Code StylePHP CS Fixer Type Coverage Yes ### Embed Badge ![Health badge](/badges/winningsoftware-symfony-base/health.svg) ``` [![Health](https://phpackages.com/badges/winningsoftware-symfony-base/health.svg)](https://phpackages.com/packages/winningsoftware-symfony-base) ``` ### Alternatives [rcsofttech/audit-trail-bundle Enterprise-grade, high-performance Symfony audit trail bundle. Automatically track Doctrine entity changes with split-phase architecture, multiple transports (HTTP, Queue, Doctrine), and sensitive data masking. 1155.2k](/packages/rcsofttech-audit-trail-bundle)[sulu/sulu Core framework that implements the functionality of the Sulu content management system 1.3k1.4M196](/packages/sulu-sulu)[kimai/kimai Kimai - Time Tracking 4.7k8.7k1](/packages/kimai-kimai)[easycorp/easyadmin-bundle Admin generator for Symfony applications 4.3k17.5M376](/packages/easycorp-easyadmin-bundle)[forumify/forumify-platform 122.0k12](/packages/forumify-forumify-platform)[open-dxp/opendxp Content & Product Management Framework (CMS/PIM) 9317.2k55](/packages/open-dxp-opendxp) PHPackages Β© 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)