feat: first commit with deployment via Github Actions

Author: neothone

.editorconfig

@@ -0,0 +1,46 @@
+# EditorConfig helps developers define and maintain consistent
+# coding styles between different editors and IDEs
+# editorconfig.org
+
+root = true
+
+[*]
+# Change these settings to your own preference
+indent_style = space
+indent_size = 4
+
+# We recommend you to keep these unchanged
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.{js,json,jsx,mjs,cjs,ts,tsx,mts,cts,vue}]
+indent_size = 2
+
+[*.md]
+trim_trailing_whitespace = false
+
+[*.sh]
+indent_style = tab
+
+[*.{yaml,yml}]
+trim_trailing_whitespace = false
+
+[.github/workflows/*.yml]
+indent_size = 2
+
+[.gitmodules]
+indent_style = tab
+
+[composer.json]
+indent_size = 4
+
+[{compose,docker-compose}.*.{yaml,yml}]
+indent_size = 2
+
+[*.*Dockerfile]
+indent_style = tab
+
+[*.*Caddyfile]
+indent_style = tab

.github/workflows/deploy.yaml

@@ -0,0 +1,44 @@
+# .github/workflows/deploy.yml
+name: Deploy Documentation
+
+on:
+  push:
+    branches: [ main ]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '22'
+          cache: 'npm'
+          
+      - name: Install dependencies
+        run: npm ci
+        
+      - name: Build
+        run: npm run build
+        
+      - name: Deploy to server
+        uses: appleboy/scp-action@master
+        with:
+          host: ${{ secrets.SERVER_HOST }}
+          username: ${{ secrets.SERVER_USER }}
+          key: ${{ secrets.SSH_PRIVATE_KEY }}
+          source: ".next/,public/,package.json,package-lock.json"
+          target: "/var/www/docs"
+          
+      - name: Execute deployment commands
+        uses: appleboy/ssh-action@master
+        with:
+          host: ${{ secrets.SERVER_HOST }}
+          username: ${{ secrets.SERVER_USER }}
+          key: ${{ secrets.SSH_PRIVATE_KEY }}
+          script: |
+            cd /var/www/fastfony/main/docs
+            npm ci --production
+            pm2 reload ecosystem.config.js || pm2 start ecosystem.config.js

.gitignore

@@ -0,0 +1,3 @@
+node_modules/
+.next/
+public/_pagefind

.npmrc

@@ -0,0 +1 @@
+enable-pre-post-scripts=true

README.md

@@ -1,6 +1,6 @@
 # Fastfony documentation
 
-This project is a documentation for Fastfony, a Symfony-based boilerplate and starter kit.
+This project is a documentation for [Fastfony](https://fastfony.com), a Symfony-based boilerplate and starter kit.
 
 It builds with Nextra, a Next.js & MDX based documentation site generator.
 

app/[[...mdxPath]]/page.jsx

@@ -0,0 +1,23 @@
+import { generateStaticParamsFor, importPage } from 'nextra/pages'
+import { useMDXComponents as getMDXComponents } from '../../mdx-components'
+
+export const generateStaticParams = generateStaticParamsFor('mdxPath')
+
+export async function generateMetadata(props) {
+  const params = await props.params
+  const { metadata } = await importPage(params.mdxPath)
+  return metadata
+}
+
+const Wrapper = getMDXComponents().wrapper
+
+export default async function Page(props) {
+  const params = await props.params
+  const result = await importPage(params.mdxPath)
+  const { default: MDXContent, toc, metadata } = result
+  return (
+    <Wrapper toc={toc} metadata={metadata}>
+      <MDXContent {...props} params={params} />
+    </Wrapper>
+  )
+}

app/layout.jsx

@@ -0,0 +1,55 @@
+import { Footer, Layout, Navbar } from 'nextra-theme-docs'
+import { Head } from 'nextra/components'
+import { getPageMap } from 'nextra/page-map'
+import 'nextra-theme-docs/style.css'
+import Image from 'next/image';
+
+export const metadata = {
+  title: 'Fastfony Documentation',
+  // For more information on metadata API, see: https://nextjs.org/docs/app/building-your-application/optimizing/metadata
+}
+
+const navbar = (
+  <Navbar
+    logo={
+      <>
+        <Image src="/favicon-32x32.png" alt="Fastfony icon" width="32" height="32" />
+        <span style={{ marginLeft: '.4em', fontWeight: 800 }}>
+        Fastfony Documentation
+      </span>
+      </>
+    }
+    // ... Your additional navbar options
+  />
+)
+const footer = <Footer>MIT {new Date().getFullYear()} © Fastfony.</Footer>
+
+export default async function RootLayout({ children }) {
+  return (
+    <html
+      // Not required, but good for SEO
+      lang="en"
+      // Required to be set
+      dir="ltr"
+      // Suggested by `next-themes` package https://github.com/pacocoursey/next-themes#with-app
+      suppressHydrationWarning
+    >
+    <Head
+      // ... Your additional head options
+    >
+      {/* Your additional tags should be passed as `children` of `<Head>` element */}
+    </Head>
+    <body>
+    <Layout
+      navbar={navbar}
+      pageMap={await getPageMap()}
+      docsRepositoryBase="https://github.com/fastfony/fastfony-docs/tree/main/docs"
+      footer={footer}
+      // ... Your additional layout options
+    >
+      {children}
+    </Layout>
+    </body>
+    </html>
+  )
+}

content/coding-style.mdx

@@ -0,0 +1,32 @@
+# Coding style
+
+If you want a project with homogeneous code, you can use the following coding style which have used in Fastfony.
+
+## Fixer with GrumPHP
+
+In order to install the git pre-commit hook, execute the command `vendor/bin/grumphp git:pre-commit`
+
+## PHP
+
+We try to have line length of 120 characters maximum.
+
+In class :
+
+- Constants in first
+- Properties in second
+- Public methods in first, after constants and properties
+- Protected methods in second, after public methods
+- 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
+
+### 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.
+
+For example, if the class is in the `Entity` directory, we don't repeat `Entity` in the class name.
+
+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.

content/css_theme.mdx

@@ -0,0 +1,7 @@
+# CSS Theme
+
+You can generate a new theme with the [daisyUI theme generator](https://v5.daisyui.com/theme-generator/).
+
+Click on the button `{} CSS` and copy the content in `assets/css/app.css`.
+
+Edit the file `templates/base.html.twig` for change the value attribute `data-theme` on `<html>` tag.

content/entities.mdx

@@ -0,0 +1,7 @@
+# Entities (Doctrine)
+
+## Usage of traits
+
+In order to limit the number of getter/setter and to have a more readable code, we use Traits for add common properties and methods to our entities.
+
+Traits available in `src/Entity/CommonProperties`