Skip to content

Flectone/FlectoneWeb

Repository files navigation

Flectone Logo

⚡️ Flectone Web

🚀 Modern web solution for Flectone Network

Built with Astro Powered by Bun Website Status License GitHub Stars GitHub Forks

🧱 Project Structure

Here’s a quick overview of the project structure:

FlectoneWeb/
├── src/                  # Astro project source files
│   ├── assets/           # Static assets (images, fonts, etc.)
│   ├── components/       # Reusable UI components
│   ├── layouts/          # Layout templates
│   ├── pages/            # Application pages and routes
│   └── styles/           # Global styles and CSS
│
├── pulse/                # VitePress documentation
│   ├── en/               # (EN)
│   └── ru/               # (RU)
│
├── dist/                 # Production build output
├── public/               # Public static files
└── package.json          # Project dependencies and scripts

🎯 Overview

Flectone Web is a modern, fast, and responsive web solution built for Flectone Network. It combines the power of Astro for the main frontend and VitePress for documentation, providing an excellent developer and user experience.

✨ Key Features

  • 🌍 Multi-language Support: Fully localized for RU and EN audiences.
  • ⚡️ Blazing Fast Performance: Optimized for speed with Astro and Vite.
  • 🎨 Modern UI: Clean, responsive design with dark/light themes.
  • 📚 Comprehensive Documentation: Built with VitePress for easy maintenance.
  • 🚀 Easy Deployment: Pre-configured build scripts for seamless deployment.

🛠️ Tech Stack

Category Technologies
Core Astro React
Styling TailwindCSS
Runtime Bun
Docs VitePress

🚀 Quick Start

Prerequisites

  • Node.js (v18 or higher)
  • Bun (v1.0 or higher)

Installation

  1. Clone the repository:
   git clone https://github.com/Flectone/FlectoneWeb.git
   cd FlectoneWeb
  1. Install dependencies:
   bun install && bun install:pulse-ru && bun install:pulse-en

Development

  • Start Astro development server:
  bun run dev
  • Start VitePress development server (RU docs):
  bun run dev:pulse-ru
  • Start VitePress development server (EN docs):
  bun run dev:pulse-en

Build

  • Build Astro project:
  bun run build
  • Build VitePress docs (RU):
  bun run build:pulse-ru
  • Build VitePress docs (EN):
  bun run build:pulse-en
  • Copy built docs to Astro dist folder:
  bun run copy:pulse
  • Build everything (Astro + VitePress docs):
  bun run build:all

Preview

  • Preview Astro build:
  bun run preview
  • Preview VitePress docs (RU):
  bun run preview:pulse-ru
  • Preview VitePress docs (EN):
  bun run preview:pulse-en

📜 Scripts Reference

Script Description
dev Start Astro development server
dev:pulse-ru Start VitePress dev server for RU docs
dev:pulse-en Start VitePress dev server for EN docs
build Build Astro project
build:pulse-ru Build RU VitePress docs
build:pulse-en Build EN VitePress docs
build:all Build everything (Astro + VitePress docs)
copy:pulse Copy built VitePress docs to Astro dist folder
preview Preview Astro build
preview:pulse-ru Preview RU VitePress docs
preview:pulse-en Preview EN VitePress docs

🤝 Contributing

We welcome contributions! Please read our Contributing Guidelines to get started.

📄 License

This project is licensed under the GPLv3 License. See the LICENSE file for details.


Made with ❤️ by Flectone Team