Skip to content

Latest commit

 

History

History
80 lines (53 loc) · 2.2 KB

README.md

File metadata and controls

80 lines (53 loc) · 2.2 KB

Overview

gnops.io is a project designed to be a community-run hub for the Gno DevOps family.

Contributing

To contribute to the project's content, please focus on the following directories:

  • content/: Contains the main content of the site.
  • english/: English language content files, classified per article kind (showcase, guides, effective-gno).
  • i18n/: Internationalization files for supporting multiple languages.

When adding or modifying content, ensure that your contributions align with the project's / front-matter structure and standards.

Sections

  • Effective gnops - best practices and good habits relating to Gno node orchestration
  • Guides - standard tutorials that cover how to go from A to B
  • Showcases - show and tell, tool spotlight, setup showcase

Installation

  1. Clone the repository:
   git clone https://github.com/gnoverse/gnops.git
   cd gnops
  1. Install dependencies:
   pnpm install

Scripts

Development

  • Start Development: Watch for changes and run Hugo, Vite, and search indexing.
    pnpm dev

  • Hugo Development Only: Run Hugo in development mode with live reload.
    pnpm dev:hugo

  • Vite Development Only: Start the Vite development server.
    pnpm dev:vite

  • Rebuild Search Index: Rebuild the search index for the dist directory.
    pnpm dev:search

Preview (for deploy previews)

  • Preview Build: Build and serve the site for preview. pnpm preview

  • Hugo Preview Only: Build the Hugo site in preview mode.

Build (for hosting)

  • Full Build: Build the site with Hugo, search indexing, and Vite.
    pnpm build

Website Dependencies

  • hugo: SSG website builder made in go
  • barba: Page transitions.
  • gsap: Animations.
  • tailwindcss: Atomic CSS system - Tailwind.
  • typescript: Type-safe JavaScript.
  • vite: Development and build tool.

Folder Structure

  • content/: Contains site content files (articles).
  • i18n/: Contains translations for internationalization.
  • assets/images/: Media files used on the site.
  • temp/: Output for built files (used by Hugo and Vite).
  • build/: Final build directory for production.