@moveo-ai/web-client 0.84.0 → 0.85.0

package/README.md

@@ -15,3 +15,120 @@
 1. Create a web integration
 1. Copy the snippet to your website html
 1. Enjoy 🚀
+
+## 🛠 Development
+
+### Prerequisites
+
+- Node.js (v16 or higher)
+- npm or yarn
+
+### Installation
+
+```bash
+# Install dependencies
+npm install
+```
+
+### Running Locally
+
+The web-client can be run in different modes depending on your development needs:
+
+#### Development Mode
+```bash
+npm start
+```
+This starts the webpack dev server on https://localhost:8880 with hot module replacement enabled.
+
+#### Local Testing with Different Environments
+
+When running locally, you can specify which Moveo Channels backend to connect to using query parameters:
+
+- **Development Backend**: Default when running locally
+- **Production Backend**: Add `?host=https://channels.moveo.ai` to your URL
+- **Custom Backend**: Add `?host=YOUR_BACKEND_URL` to test against different environments
+
+Example URLs:
+```
+https://localhost:8880/?integration_id=YOUR_ID&host=https://channels.moveo.ai  # Production
+https://localhost:8880/?integration_id=YOUR_ID&host=https://dev-channels.moveo.ai  # Dev
+https://localhost:8880/?integration_id=YOUR_ID  # Uses default development backend
+```
+
+### Build Commands
+
+```bash
+# Production build (minified)
+npm run build
+
+# Development build (unminified)
+npm run build:dev
+
+# Watch mode for continuous builds
+npm run watch
+```
+
+### Testing
+
+```bash
+# Run unit tests
+npm test
+
+# Run E2E tests
+npm run test:ci
+
+# Run specific Playwright test
+npx playwright test tests/custom-fields.spec.ts
+
+# Run specific Jest test
+jest src/components/Header/Header.test.tsx
+```
+
+### Code Quality
+
+```bash
+# Run linters
+npm run lint
+
+# Auto-fix linting issues
+npm run autofix
+
+# Format code with Prettier
+npm run prettier
+
+# Type checking
+npm run type-check
+```
+
+### Storybook
+
+```bash
+# Run Storybook development server
+npm run storybook
+
+# Build Storybook for production
+npm run build-storybook
+```
+
+## 🚀 Deployment
+
+### Current: Cloudflare Pages
+
+The web-client is currently deployed to **Cloudflare Pages**, providing:
+- Global CDN distribution
+- Automatic deployments from GitHub
+- Preview deployments for pull requests
+- Zero-config SSL/TLS
+
+### Previous: Vercel
+
+The project was originally deployed on Vercel but has been migrated to Cloudflare Pages for improved performance and better integration with our infrastructure.
+
+### Deployment Configuration
+
+The production build is automatically deployed when changes are pushed to the `main` branch. Preview deployments are created for pull requests to the `next` branch.
+
+Build settings:
+- Build command: `npm run build`
+- Build output directory: `dist`
+- Node version: 16+