From 965c8f4ea9de020682efab05dd033e205f784677 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Mon, 29 Sep 2025 09:21:31 +0000 Subject: [PATCH 2/2] Add complete installation and deployment infrastructure Co-authored-by: sahiixx <221578902+sahiixx@users.noreply.github.com> --- INSTALL.md | 175 +++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 42 +++++++++++++ 2 files changed, 217 insertions(+) create mode 100644 INSTALL.md diff --git a/INSTALL.md b/INSTALL.md new file mode 100644 index 00000000..9d7c50c7 --- /dev/null +++ b/INSTALL.md @@ -0,0 +1,175 @@ +# Installation and Deployment Guide + +## 📋 Prerequisites + +- Node.js (version 18 or later) +- Git +- A GitHub account (for GitHub Pages deployment) + +## 🚀 Quick Start + +### Local Installation + +1. **Clone the repository:** + ```bash + git clone https://github.com/sahiixx/system-prompts-and-models-of-ai-tools.git + cd system-prompts-and-models-of-ai-tools + ``` + +2. **Install dependencies:** + ```bash + cd site + npm install + ``` + +3. **Build the site:** + ```bash + npm run build + ``` + +4. **Preview locally:** + ```bash + npm run preview + ``` + The site will be available at `http://localhost:8000` + +### Development Mode + +For development with auto-rebuild: +```bash +npm run dev +``` + +## 🌐 Deployment Options + +### GitHub Pages (Automatic) + +The repository is configured for automatic deployment to GitHub Pages: + +1. **Enable GitHub Pages:** + - Go to your repository Settings → Pages + - Set Source to "GitHub Actions" + +2. **Trigger Deployment:** + - Push to the `main` branch + - Or manually trigger via Actions tab + +3. **Access your site:** + - Your site will be available at: `https://[username].github.io/system-prompts-and-models-of-ai-tools/` + +### Manual Deployment + +#### Deploy to Vercel + +1. Install Vercel CLI: + ```bash + npm install -g vercel + ``` + +2. Deploy: + ```bash + cd site + npm run build + vercel --prod + ``` + +#### Deploy to Netlify + +1. Build the site: + ```bash + cd site + npm run build + ``` + +2. Upload the `dist` folder to Netlify or connect your GitHub repository + +#### Deploy to any static host + +1. Build the site: + ```bash + npm run build + ``` + +2. Upload the contents of `site/dist` to your web server + +## 🔧 Configuration + +### Environment Variables + +- `BASE_PATH`: Set the base path for deployment (default: `/`) + ```bash + BASE_PATH=/my-subfolder/ npm run build + ``` + +### Custom Styling + +The build script includes embedded CSS. To customize: + +1. Edit the `generateHTML` function in `site/build.js` +2. Modify the `