mirror of https://github.com/StarFleetCPTN/GoMFT.git synced 2026-09-08 15:41:20 +02:00

Files

T

StarFleetCPTN 834f066704 feat: Integrate Docusaurus for documentation and enhance project structure

- Added Docusaurus configuration and initial setup for documentation.
- Created multiple documentation pages covering installation, configuration, and core concepts.
- Implemented a GitHub Actions workflow for automatic deployment of documentation to GitHub Pages.
- Updated .gitignore to exclude Docusaurus build artifacts and dependencies.
- Enhanced README with a link to the online documentation.

2025-04-12 13:01:53 -07:00

1.3 KiB

Raw Permalink Blame History

GoMFT Documentation

This repository contains the documentation for GoMFT, a modern, web-based managed file transfer solution written in Go.

Getting Started

Installation

# Install dependencies
npm install

# Start the development server
npm run start

Build

# Build the static site
npm run build

The built files will be in the build directory.

Documentation Structure

Introduction: Overview and features of GoMFT
Getting Started: Installation guides and quick start
Core Concepts: Detailed information about transfers, connections, and schedules
Advanced Features: Webhooks, email notifications, and admin tools
Security: Security best practices and configuration
Development: Project structure and contributing guidelines

Contributing

Contributions to the documentation are welcome! Please submit a PR with your changes.

Community

Join our Discord community for support, discussions, and updates about GoMFT.

License

This documentation is licensed under the MIT License - see the LICENSE file for details.

1.3 KiB Raw Permalink Blame History