Merge pull request #21 from vplend/dev

[2.0.0] (WIP) Migration to NextJS&Fumadocs

Author: TheFaser

.github/workflows/deploy.yml

@@ -9,34 +9,36 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - name: Checkout code
-      uses: actions/checkout@v4
-
-    - name: Set up Node.js
-      uses: actions/setup-node@v3
-      with:
-        node-version: '18'
-
-    - name: Install Bun
-      run: |
-        curl -fsSL https://bun.sh/install | bash
-        echo "$HOME/.bun/bin" >> $GITHUB_PATH
-
-    - name: Install dependencies
-      run: bun install && bun install:pulse-ru && bun install:pulse-en
-
-    - name: Build project
-      run: bun run build:all
-
-    - name: Deploy to server
-      uses: easingthemes/ssh-deploy@main
-      with:
-        SSH_PRIVATE_KEY: ${{ secrets.SSH_PRIVATE_KEY }}
-        ARGS: "-rlgoDzvc -i"
-        SOURCE: "dist/*"
-        REMOTE_HOST: ${{ secrets.REMOTE_HOST }}
-        REMOTE_USER: ${{ secrets.REMOTE_USER }}
-        REMOTE_PORT: ${{ secrets.REMOTE_PORT }}
-        TARGET: ${{ secrets.REMOTE_TARGET }}
-        SCRIPT_BEFORE: |
-          rm -rf ${{ secrets.REMOTE_TARGET }}/*
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '18'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build project
+        run: npm run build
+
+      - name: Copy static files
+        run: cp -r .next/static .next/standalone/.next/
+
+      - name: Deploy to server
+        uses: easingthemes/ssh-deploy@main
+        with:
+          SSH_PRIVATE_KEY: ${{ secrets.SSH_PRIVATE_KEY }}
+          ARGS: "-rlgoDzvc -i"
+          SOURCE: ".next/standalone/*"
+          REMOTE_HOST: ${{ secrets.REMOTE_HOST }}
+          REMOTE_USER: ${{ secrets.REMOTE_USER }}
+          REMOTE_PORT: ${{ secrets.REMOTE_PORT }}
+          TARGET: ${{ secrets.REMOTE_TARGET }}
+          SCRIPT_BEFORE: |
+            pm2 stop next-app 2>/dev/null || true
+            rm -rf ${{ secrets.REMOTE_TARGET }}/*
+          SCRIPT_AFTER: |
+            cd ${{ secrets.REMOTE_TARGET }}
+            pm2 start server.js --name "next-app"

.gitignore

@@ -1,36 +1,44 @@
-# build output
-dist/
-
-# generated types
-.astro/
-package-lock.json
-bun.lock
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
 
 # dependencies
-node_modules/
+/node_modules
+/.pnp
+.pnp.*
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/versions
+
+# testing
+/coverage
+
+# next.js
+/.next/
+/out/
+/.source
+
+# production
+/build
+
+# misc
+.DS_Store
+*.pem
 
-# logs
+# debug
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
-pnpm-debug.log*
-
-# environment variables
-.env
-.env.production
+.pnpm-debug.log*
 
-# macOS-specific files
-.DS_Store
+# env files (can opt-in for committing if needed)
+.env*
 
-# jetbrains setting folder
-.idea/
+# vercel
 .vercel
 
-FlectonePulseDocs.iml
-.vitepress/dist/*
-/.idea/*
-/pulse/ru/.vitepress/dist/
-/pulse/ru/.vitepress/cache/
-/pulse/en/.vitepress/dist/
-/pulse/en/.vitepress/cache/
-/.vscode/*
+# typescript
+*.tsbuildinfo
+next-env.d.ts
+
+

CONTRIBUTING.md

@@ -1,14 +1,17 @@
 # 🤝 Contributing to Flectone Web
 
-Thanks for wanting to help! Here’s how to get started.
+Thanks for wanting to help! Here’s how to get started with our Next.js & Fumadocs based project.
 
 ---
 
 ## 🛠️ Getting Started
 
 1. **Fork the repo** on GitHub.
 2. **Clone your fork** locally.
-3. **Install dependencies** using Bun.
+3. **Install dependencies** using npm:
+   ```bash
+   npm install
+   ```
 4. **Create a branch** for your changes.
 5. **Make your changes** and test them.
 6. **Commit and push** your changes.
@@ -23,38 +26,47 @@ Thanks for wanting to help! Here’s how to get started.
 - Include screenshots or logs if needed.
 
 ### Code Contributions
-- Follow existing code style.
-- Test your changes.
+- Follow existing code style (we use ESLint).
+- Test your changes by running the development server.
 - Keep PRs focused on one issue or feature.
+- If you are adding documentation for **Pulse**, place it in `src/pulse/` or relevant `[lang]` directories.
 
 ### Documentation
-- Fix typos, outdated info, or unclear sections.
+- We use **MDX** with **Fumadocs**.
+- Use `<include>` tags for reusable parts and localizations where possible, following the pattern in existing `.mdx` files.
+- Fix typos, outdated info, or unclear sections in `src/messages/` (JSON) or content files.
 
 ---
 
 ## 🚀 Development
 
 ### Running the Project
-- Start Astro dev server: `bun run dev`
-- Start VitePress (RU): `bun run dev:pulse`
-- Start VitePress (EN): `bun run dev:en-pulse`
+- Start the development server:
+   ```bash
+   npm run dev
+   ```
+- The site will be available at `http://localhost:3000`.
 
 ### Building the Project
-- Build Astro: `bun run build`
-- Build VitePress (RU): `bun run build:pulse`
-- Build VitePress (EN): `bun run build:en-pulse`
-- Build everything: `bun run build:all`
+- Build the Next.js application:
+   ```bash
+   npm run build
+   ```
+- To check for production errors locally:
+   ```bash
+   npm run start
+   ```
 
 ---
 
 ## 🧐 Code Review
 
 - PRs will be reviewed by maintainers.
 - Feedback will be provided if changes are needed.
-- Once approved, your changes will be merged.
+- Once approved, your changes will be merged into the main branch.
 
 ---
 
 ## 🙏 Thanks!
 
-Your contributions make Flectone Web better. Happy coding! 🚀
+Your contributions make Flectone Web better. Happy coding! 🚀