Skip to content

Latest commit

 

History

History
79 lines (59 loc) · 1.98 KB

PUBLISHING.md

File metadata and controls

79 lines (59 loc) · 1.98 KB

🚀 Publishing Guide for python-react-ml

Step 1: Create GitHub Repository

  1. Go to GitHub.com and create a new repository
  2. Repository name: python-react-ml
  3. Description: Run Python ML models directly in React and React Native apps - no backend required
  4. Make it Public
  5. Don't initialize with README (we already have one)

Step 2: Update Repository Information

Run this command with your GitHub details:

./update-repo-urls.sh YOUR_GITHUB_USERNAME "Your Name" "your.email@example.com"

Example:

./update-repo-urls.sh johndoe "John Doe" "john@example.com"

Step 3: Publish to GitHub

Run this command with your GitHub username:

./setup-remote.sh YOUR_GITHUB_USERNAME

Example:

./setup-remote.sh johndoe

Step 4: Publish to npm (Optional)

To publish the packages to npm registry:

  1. Login to npm:

    npm login

  2. Publish all packages:

    npm run publish:all

🎯 What Gets Published

GitHub Repository

  • ✅ Complete monorepo with all packages
  • ✅ Working examples (React web + React Native)
  • ✅ Documentation and guides
  • ✅ MIT License
  • ✅ CI/CD ready structure

npm Packages (if you choose to publish)

  • @python-react-ml/core - Core Python execution engine
  • @python-react-ml/react - React hooks and components
  • @python-react-ml/react-native - React Native bridge
  • @python-react-ml/cli - CLI tools for bundling models

🔑 Package Access

The framework will be available as:

  • GitHub: https://github.com/YOUR_USERNAME/python-react-ml
  • npm: npm install @python-react-ml/react (if published)

📊 Repository Stats

  • 4 packages (core, react, react-native, cli)
  • 2 working examples
  • All tests passing ✅
  • Production ready ✅
  • TypeScript support ✅
  • Zero backend required ✅

Your framework is ready to help developers run Python ML models directly in their React and React Native apps! 🎉