major update for RC1

neothone · neothone · commit 0dbc0f759a2a · 2025-06-14T09:46:39.000+02:00
diff --git a/content/features.mdx b/content/features.mdx
@@ -0,0 +1,27 @@
+# Features
+
+- Simple pages with HTML or custom twig template and SEO friendly (front and backoffice)
+- Collections & records builder
+- Taxonomy management (categories, tags, etc.)
+- Register and received a login link by email
+- Contact requests form
+- Complete user management with Profile (and Groups, Roles) and security features :
+  - Login form with email that send a login link by email
+  - Login form with password
+  - Login with OAuth clients (Google and Github are already installed)
+  - Profile with photo (and upload on AWS S3 if you want, with VichUploader and Flysystem)
+  - Permissions matrix for the management of the user's rights
+  - Reset password by email
+- Complete product management linked to your [Stripe](https://stripe.com) account (if you want) with front and backoffice :
+  - Product page
+  - Products list
+  - Buy with Stripe and save orders (subscription or one-time payment)
+- Scheduler dashboard and logs : list configured recurring messages and display logs
+- CRUD controllers for : Parameters, Parameter categories, Contact requests, etc.
+- Settings panel
+- DaisyUI themes chooser
+- Toasts notifications (flash messages from Symfony and others with [vue-toastification](https://vue-toastification.maronato.dev/))
+- OAuth2 Server for authenticated registered users and by applications/clients via OAuth2 grant types (password, client credentials, authorization code, refresh token)
+- Public, internal and private with OAuth2 API (you can use it as a headless CMS!)
+- I18n ready with Vue I18n and Symfony translation component
+- Edit translations in place
diff --git a/content/for-admin-users/collections.mdx b/content/for-admin-users/collections.mdx
@@ -0,0 +1 @@
+This documentation page about collections feature will be available later...
diff --git a/content/for-admin-users/contact-requests.mdx b/content/for-admin-users/contact-requests.mdx
@@ -0,0 +1 @@
+This documentation page about contact requests feature will be available later...
diff --git a/content/for-admin-users/pages.mdx b/content/for-admin-users/pages.mdx
@@ -0,0 +1 @@
+This documentation page about pages feature will be available later...
diff --git a/content/for-admin-users/products.mdx b/content/for-admin-users/products.mdx
@@ -0,0 +1 @@
+This documentation page about products feature will be available later...
diff --git a/content/for-admin-users/scheduler.mdx b/content/for-admin-users/scheduler.mdx
@@ -0,0 +1 @@
+This documentation page about scheduler and messenger features will be available later...
diff --git a/content/for-admin-users/settings.mdx b/content/for-admin-users/settings.mdx
@@ -0,0 +1 @@
+This documentation page about settings feature will be available later...
diff --git a/content/for-admin-users/stripe-integration.mdx b/content/for-admin-users/stripe-integration.mdx
@@ -0,0 +1 @@
+This documentation page about [Stripe](https://stripe.com) integration will be available later...
diff --git a/content/for-admin-users/taxonomies.mdx b/content/for-admin-users/taxonomies.mdx
@@ -0,0 +1 @@
+This documentation page about taxonomies feature will be available later...
diff --git a/content/for-admin-users/users-management.mdx b/content/for-admin-users/users-management.mdx
@@ -0,0 +1 @@
+This documentation page about users management feature will be available later...
diff --git a/content/for-developers/coding-style.mdx b/content/for-developers/coding-style.mdx
@@ -1,12 +1,27 @@
 # Coding style
 
-If you want a project with homogeneous code, you can use the following coding style which have used in Fastfony.
+If you want a project with homogeneous code, you can use the following coding style which we have used in Fastfony.
 
-## Fixer with GrumPHP
+## .editorconfig
+
+
+
+## Fixers with [GrumPHP](https://github.com/phpro/grumphp)
 
 In order to install the git pre-commit hook, execute the command `vendor/bin/grumphp git:pre-commit`
 
-## PHP
+## Other tools
+
+Fastfony comes with preconfigured :
+- [Prettier](https://prettier.io)
+- [ESlint](https://eslint.org)
+- [PHPStan](https://phpstan.org) (run `task phpstan`)
+- [PHP Insights](https://github.com/nunomaduro/phpinsights) (run `task phpinsights`)
+- [PHP_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer)
+
+## Conventions
+
+### PHP
 
 We try to have line length of 120 characters maximum.
 
@@ -19,9 +34,9 @@ In class :
 - Private methods in third, after protected methods
 - If multiple arguments in a declaration or usage of method, we put each argument on a new line with a comma at the end of the line
 
-### Naming
+#### Naming
 
-### No suffix for class name
+##### No suffix for class name
 
 In order to evict repetition (and long name) when the directory name is included in the class name, we don't repeat it in the class name.
 
@@ -30,3 +45,7 @@ For example, if the class is in the `Entity` directory, we don't repeat `Entity`
 It's obvious for the entities class, so we apply this rule for all classes.
 
 For example, controller class `src/Controller/LoginController.php` will be named `Login` without `Controller` suffix.
+
+### Javascript
+
+### HTML & CSS
diff --git a/content/for-developers/css_theme.mdx b/content/for-developers/css_theme.mdx
@@ -1,6 +1,6 @@
 # CSS Theme
 
-You can generate a new theme with the [daisyUI theme generator](https://v5.daisyui.com/theme-generator/).
+You can generate a new theme with the [daisyUI theme generator](https://daisyui.com/theme-generator).
 
 Click on the button `{} CSS` and copy the content in `assets/css/app.css`.
 
diff --git a/content/for-developers/entities.mdx b/content/for-developers/entities.mdx
diff --git a/content/for-developers/go-to-production.mdx b/content/for-developers/go-to-production.mdx
diff --git a/content/for-developers/install-start.mdx b/content/for-developers/install-start.mdx
@@ -0,0 +1,23 @@
+# Install and start Fastfony
+
+## Create new project
+
+We recommend creating a new development project on a local development machine and follow the [Go to production](for-developers/go-to-production) instructions to deploy it on a production server.
+
+1. Go on [Fastfony Github template link ](https://github.com/new?template_name=fastfony&template_owner=fastfony) in order to create your own repository from the template.
+2. Clone the repository to your local machine using the command:
+
+```bash
+git clone https://github.com/your-username/your-repo-name.git
+```
+3. Go in the new repo directory `cd your-repo-name`
+
+## Start Fastfony
+
+1. Run `task start` and follow instructions in console.
+2. If you want use OAuth2 server run `task oauth2-server-init`
+3. Enjoy!
+
+By default, Fastfony is available if you use [Symfony local proxy](https://symfony.com/doc/current/setup/symfony_server.html#setting-up-the-local-proxy) at [https://fastfony.wip/](https://fastfony.wip/) or [https://localhost:9876](https://localhost:9876) if not.
+
+_You can change the hostname or the port by modifying the `.symfony.local.yaml` file._
diff --git a/content/for-developers/internal-api.mdx b/content/for-developers/internal-api.mdx
@@ -0,0 +1 @@
+This documentation page about the Internal API of Fastfony will be available later...
diff --git a/content/for-developers/oauth2-server.mdx b/content/for-developers/oauth2-server.mdx
@@ -0,0 +1,28 @@
+# OAuth2 Server
+
+Fastfony comes with a built-in OAuth2 server that allows you to authenticate users and applications using various OAuth2 grant types.
+This is useful for securing your API and allowing third-party applications to access it securely.
+With users management it can also be used to authenticate users in yours applications.
+
+## Configuration
+
+If not already done, you can configure the OAuth2 server by running the following command:
+
+```bash
+task oauth2-server-init
+```
+
+## Test OAuth2 server with Swagger UI
+
+Steps :
+
+1. Create a new client in OAuth2 server admin section : https://fastfony.wip/admin/client-crud
+2. Indicate this redirect URI string for SwaggerUI : https://fastfony.wip/bundles/apiplatform/swagger-ui/oauth2-redirect.html
+3. Affect the new OAuth client to users
+4. Go to swagger UI : https://fastfony.wip/api/docs
+5. Click on the Authorize button
+6. Fill in the form with the client identifier and secret
+7. Select the scope you want to use and you have configured in the client
+8. Click on the Authorize button
+9. Try the API with the OAuth2 authentication
+
diff --git a/content/for-developers/public-api.mdx b/content/for-developers/public-api.mdx
@@ -0,0 +1 @@
+This documentation page about the Public API of Fastfony will be available later...
diff --git a/content/for-developers/repositories.mdx b/content/for-developers/repositories.mdx
diff --git a/content/for-developers/specific-things.mdx b/content/for-developers/specific-things.mdx
@@ -0,0 +1,4 @@
+# Specific things
+
+- Translation files are not in `./translations` directory but in `./assets/locales` directory in order to use [vue-i18n](https://vue-i18n.intlify.dev/) and symfony translation component. We try to apply [php-translation best practices](https://php-translation.readthedocs.io/en/latest/best-practice/index.html).
+- In directories `pro` or `Pro` you can find the pro features of Fastfony. You can use them if you have a license. If you don't have a license, you can use only in development mode.
diff --git a/content/index.mdx b/content/index.mdx
@@ -1,8 +1,23 @@
-# Get started with Fastfony
+# Get started with [Fastfony](https://fastfony.com)
 
-[Fastfony](https://fastfony.com) is a [Symfony](https://symfony.com) boilerplate and starter kit that provides a solid foundation for building web applications. It includes a variety of features and tools to help you get started quickly and efficiently.
+[Fastfony](https://fastfony.com) is a [Symfony](https://symfony.com) boilerplate and starter kit that provides a solid foundation for building web applications or API. It includes a variety of features and tools to help you get started quickly and efficiently.
 
-## Prerequisites
+This starter kit is free and open-source, but pro features for commercial use are available with a [license](https://fastfony.com/pricing). It is designed to be easy to use and customize, so you can focus on building your Symfony application without worrying about the underlying infrastructure.
+
+## How to use the boilerplate or the starter kit
+
+You can use Fastfony as a boilerplate or as a starter kit:
+- **Boilerplate**: Fastfony comes with a technology stack (PHP, Symfony, Doctrine, Webpack Encore, Tailwind CSS, DaisyUI, Vue 3, etc.) but you can use other technologies if you want. It provides a solid foundation for your project, but you can customize it as needed. You can remove or add according to your requirements.
+- **Starter-kit** : Fastfony comes with set of features (user management, product management, API, etc.) that you can use as a starting point for your project. You can customize it to fit your needs.
+
+Fastfony may seem like a big project with a lot of stuff you won't need, but no matter, if you don't need certain features don't use them or remove them!
+
+This boilerplate and starter kit build with PHP is designed to save you time when starting a new project with Symfony.
+
+- Check the [technology stack](/technology-stack) used in Fastfony.
+- Discover the [features](/features) of Fastfony and how to use it in your project.
+
+## Prerequisites and installation
 
 Before you begin, ensure you have the following installed on your machine:
 
@@ -19,54 +34,4 @@ Be careful to the minimum versions requirements:
 - Symfony CLI: 5.11
 - Node: 22 with npm and _npx_
 
-## Create new project
-
-We recommend creating a new development project on a local development machine and follow the "Go to production" (soon available...) instructions to deploy it on a production server.
-
-You can create a new project using one of the following methods:
-
-### Solution 1 : From archive
-
-Extract the download archive and in the root of the project, run the following command:
-
-```bash
-git init
-git add .
-git commit -m "Initial commit"
-```
-
-If you want synchronize your new project with the template repository of Fastfony or Fastfony Pro, run the following command:
-
-For Fastfony:
-
-```bash
-curl -sSL https://raw.githubusercontent.com/coopTilleuls/template-sync/main/template-sync.sh | sh -s -- https://github.com/fastfony/fastfony
-```
-
-For Fastfony Pro:
-
-```bash
-curl -sSL https://raw.githubusercontent.com/coopTilleuls/template-sync/main/template-sync.sh | sh -s -- git@github.com:fastfony/fastfony-pro.git
-```
-
-And then resolve conflicts, if any, and run `git cherry-pick --continue`.
-
-Then, run the following command:
-
-```bash
-task start
-```
-
-### Solution 2 : From template repositories
-
-Go on github in order to create your own repository from the template, with this link:
-* for Fastfony: https://github.com/new?template_name=fastfony&template_owner=fastfony
-* for Fastfony Pro: https://github.com/new?template_name=fastfony-pro&template_owner=fastfony
-
-You can claim your access to the Fastfony Pro repository by sending e-mail to claim-repo-access@fastfony.com.
-
-Then clone the repository and in the root of the project, run the following command:
-
-```bash
-task start
-```
+Then, proceed to [install & start](/for-developers/install-start) Fastfony.
diff --git a/content/technology-stack.mdx b/content/technology-stack.mdx
@@ -0,0 +1,15 @@
+# Technology Stack
+
+- Symfony 7.3
+- API Platform 4.1
+- EasyAdmin 4 (with Bootstrap 5)
+- Vue.js 3 & Bootstrap 5 for admin (with EasyAdmin)
+- Vue.js 3 & Tailwind CSS 4 & DaisyUI 5 for front (and you can use also React or another frontend framework!)
+- Vueuse, AG Grid, Vue I18n, Pinia, FormKit, PrimeVue and others for front
+- Webpack Encore
+- Taskfile for easy install & start commands (just `task start` and develop)
+- Flysystem for file storage management (local and AWS S3 ready)
+- GrumPHP for manage pre-hook commit
+- PHPUnit and its unit and functional tests
+- PHPStan (level 5, [symfony simplify rules](https://github.com/symplify/phpstan-rules) and [symfony extension](https://github.com/phpstan/phpstan-symfony))
+- PHP Insights

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+This documentation page about collections feature will be available later...`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+This documentation page about contact requests feature will be available later...`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+This documentation page about pages feature will be available later...`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+This documentation page about products feature will be available later...`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+This documentation page about scheduler and messenger features will be available later...`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+This documentation page about settings feature will be available later...`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+This documentation page about [Stripe](https://stripe.com) integration will be available later...`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+This documentation page about taxonomies feature will be available later...`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+This documentation page about users management feature will be available later...`