Outseta React On-Page Starter

A modern React application built with Vite, and Outseta set to use the on-page embed mode.

🚀 Quick Start

0. Prerequisite

   • An Outseta account set up with at least one plan and one email list.

1. Install Dependencies

   npm install

2. Configure Outseta

   Copy the .env.example file to .env:

   cp .env.example .env

   Edit the .env file and set the VITE_OUTSETA_DOMAIN environment variable to your Outseta domain.

   And set the VITE_OUTSETA_NEWSLETTER_ID environment variable to the ID of the Outseta email list you want to use.

3. Start Development Server

   npm run dev

   This will start the development server at http://localhost:5173

4. Build for Production

   npm run build

📚 Available Scripts

• npm run dev - Start development server with hot reload
• npm run build - Build for production
• npm run lint - Run ESLint
• npm run preview - Preview production build locally

🏗️ Project Structure

project-root/
├── public/          # Static assets
├── src/
│   ├── components/  # Reusable React components
│   ├── App.jsx     # Main application component
│   └── main.jsx    # Application entry point
├── index.html      # HTML entry point
└── vite.config.js  # Vite configuration

🔧 Technologies

• Outseta - Authentication, User Management, Billing, etc.
• React - UI Library
• Vite - Build tool and development server
• ESLint - Code linting

📚 Documentation

• Example use of intergrating Outseta with React
• Outseta Knowledge Base

🤝 Contributing

1. Fork the repository
2. Create a new branch (git checkout -b feature/amazing-feature)
3. Make your changes
4. Commit your changes (git commit -m 'Add some amazing feature')
5. Push to the branch (git push origin feature/amazing-feature)
6. Open a Pull Request

📜 License

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