beefreeSDK-nocode-content-editor-cursorrules-prompt-file

Beefree SDK Guidelines

Guidelines and best practices for building applications with Beefree SDK, including installation, authentication, configuration, customization, and template management.

Installation Guidelines

Package Installation

• Install the Beefree SDK package using npm or yarn:

  npm install @beefree.io/sdk
  # or
  yarn add @beefree.io/sdk
  

Dependencies

• Beefree SDK requires the following core dependencies:

  {
    "dependencies": {
      "@beefree.io/sdk": "^9.0.2-fix-optional-url-config.0",
      "axios": "^1.10.0",
      "express": "^5.1.0",
      "cors": "^2.8.5",
      "dotenv": "^17.2.0"
    }
  }
  

Environment Setup

• Create a .env file in your project root with your Beefree credentials:

  BEE_CLIENT_ID=your_client_id_here
  BEE_CLIENT_SECRET=your_client_secret_here
  

Authentication Guidelines

Proxy Server Setup

• ALWAYS use a proxy server for authentication to protect your credentials
• Create a proxy server file (e.g., proxy-server.js) to handle authentication:

  import express from 'express';
  import cors from 'cors';
  import axios from 'axios';
  import dotenv from 'dotenv';
  
  dotenv.config();
  
  const app = express();
  const PORT = 3001;
  
  app.use(cors());
  app.use(express.json());
  
  const BEE_CLIENT_ID = process.env.BEE_CLIENT_ID;
  const BEE_CLIENT_SECRET = process.env.BEE_CLIENT_SECRET;
  
  // V2 Auth Endpoint
  app.post('/proxy/bee-auth', async (req, res) => {
    try {
      const { uid } = req.body;
      
      const response = await axios.post(
        'https://auth.getbee.io/loginV2',
        {
          client_id: BEE_CLIENT_ID,
          client_secret: BEE_CLIENT_SECRET,
          uid: uid || 'demo-user'
        },
        { headers: { 'Content-Type': 'application/json' } }
      );
      
      res.json(response.data);
    } catch (error) {
      console.error('Auth error:', error.message);
      res.status(500).json({ error: 'Failed to authenticate' });
    }
  });
  
  app.listen(PORT, () => {
    console.log(`Proxy server running on http://localhost:${PORT}`);
  });