Skip to content

tfgrid-studio/tfgrid-install

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

15 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

TFGrid Install Website

The official installation website for TFGrid Compose. Provides a beautiful, simple interface for users to install TFGrid Compose with a single command. Built with Astro and deployed to GitHub Pages.

🌐 Live Website

Visit install.tfgrid.studio to install TFGrid Compose.

πŸš€ Features

  • One-Click Installation: Simple copy-paste installation command
  • Copy to Clipboard: Easy copying of the install command with visual feedback
  • Responsive Design: Works beautifully on desktop and mobile
  • Ecosystem Overview: Links to all TFGrid Studio services
  • Fast & Lightweight: Static site with excellent performance

πŸ› οΈ Technology Stack

  • Framework: Astro - Modern web framework
  • Styling: Tailwind CSS - Utility-first CSS
  • Icons: Custom SVG icons
  • Deployment: GitHub Pages with automated CI/CD

πŸ“ Project Structure

tfgrid-install/
β”œβ”€β”€ public/                         # Static assets
β”‚   β”œβ”€β”€ favicon.svg                # Site favicon
β”‚   └── CNAME                      # Custom domain configuration
β”œβ”€β”€ src/
β”‚   └── pages/
β”‚       └── index.astro           # Main install page
β”œβ”€β”€ astro.config.mjs              # Astro configuration
β”œβ”€β”€ tailwind.config.mjs           # Tailwind configuration
β”œβ”€β”€ package.json                  # Dependencies and scripts
β”œβ”€β”€ install.sh                    # The actual install script
└── README.md                     # This file

πŸƒβ€β™‚οΈ Development

Prerequisites

  • Node.js 18+
  • npm or yarn

Local Development

  1. Clone the repository:

    git clone https://github.com/tfgrid-studio/tfgrid-install.git
    cd tfgrid-install
  2. Install dependencies:

    npm install
  3. Start development server:

    npm run dev
  4. Open your browser to http://localhost:4321

The development server supports hot reloading - changes will be reflected immediately.

Build for Production

npm run build

This creates a dist/ directory with the production build.

Preview Production Build

npm run preview

Serves the production build locally for testing.

πŸš€ Deployment

Automatic Deployment

The website is automatically deployed to GitHub Pages when changes are pushed to the main branch via GitHub Actions.

Manual Deployment

# Build the site
npm run build

# The dist/ folder contains the built site ready for deployment

πŸ”§ Configuration

Custom Domain

The site is configured to deploy to install.tfgrid.studio via the public/CNAME file.

🎨 Design

The site features a beautiful purple gradient background with glassmorphism effects, using the TFGrid Studio brand colors.

  • Background: Purple to indigo gradient
  • Accent Colors: Indigo and purple tones
  • Typography: Clean, modern fonts
  • Effects: Backdrop blur and subtle animations

πŸ“Š Installation Command

The site provides the following installation command:

curl -sSL install.tfgrid.studio/install.sh | sh

This command:

  • Downloads the install script from install.tfgrid.studio
  • Pipes it to bash for execution
  • Installs TFGrid Compose system-wide

πŸ”— Ecosystem Links

The site provides quick access to:

🀝 Contributing

Code Contributions

  1. Fork the repository
  2. Create a feature branch: git checkout -b feature/new-feature
  3. Make your changes
  4. Test locally: npm run dev
  5. Commit and push your changes
  6. Submit a pull request

Content Updates

  • Ensure the installation command remains accurate
  • Keep ecosystem links up to date
  • Maintain responsive design across all devices

πŸ“ˆ Performance

  • Lighthouse Score: Targets 90+ on all metrics
  • Bundle Size: Optimized with Astro's built-in optimizations
  • Loading Speed: Fast initial page loads with minimal JavaScript

πŸ› Troubleshooting

Common Issues

Build fails:

# Clear cache and reinstall
rm -rf node_modules package-lock.json
npm install

Getting Help

πŸ“„ License

Licensed under the Apache License 2.0. See LICENSE for details.


Ready to install TFGrid Compose? Visit install.tfgrid.studio or run the command above!

About

One-line installer for tfgrid-compose - install.tfgrid.studio

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published