nodebeam

🚀 NodeBeam

Fast Dependency Delivery for Node.js Projects

NodeBeam is a CLI tool that dramatically speeds up your node_modules setup by leveraging GitHub Actions to install dependencies in the cloud and deliver them to your local project as a ready-to-use zip file.

Why NodeBeam?

• Save Time: Installing dependencies with npm install can take several minutes, especially for large projects. NodeBeam typically delivers your node_modules in under 30 seconds.
• Consistent Installs: NodeBeam uses a clean CI environment, ensuring reproducible installs and avoiding local cache issues.
• No More Waiting: Get straight to coding without waiting for slow dependency downloads.
• Works Anywhere: Perfect for fresh setups, CI/CD pipelines, and team environments.

Typical npm install time: 2-5 minutes

NodeBeam average delivery: 20-40 seconds

How It Works

• Upload your package.json and package-lock.json to a temporary GitHub branch.
• GitHub Actions installs your dependencies in the cloud.
• NodeBeam downloads the ready-to-use node_modules.zip artifact.
• Extract and start coding instantly.

Quick Start

Installation

npm install -g nodebeam

Beam Dependencies

# In your project directory
nodebeam

This will:

• Upload your dependency manifest to GitHub
• Trigger a cloud install
• Download and extract your node_modules locally

Configuration

On first run, NodeBeam will prompt for:

• GitHub Personal Access Token (for API access)
• GitHub Repository (format: owner/repo)

Your config is saved in ~/.nodebeam-config.json:

{
  "token": "your-github-token",
  "repo": "yourusername/your-repo"
}

Benefits

• Instant setup for new team members
• Reliable, reproducible installs
• No local npm/network issues
• Great for CI/CD and automation

Requirements

• Node.js 14+
• Git installed
• GitHub account and token
• Internet connection

Use Cases

Team Development

• New developers can instantly set up projects by downloading pre-built dependencies.
• No more waiting for slow installs or troubleshooting local issues.

CI/CD Integration

• Speed up build pipelines by reusing cloud-installed dependencies.
• Ensure consistent environments across all deployments.

Offline Development

• Download dependencies once and reuse the zip for offline work.

How NodeBeam Works Under the Hood

1. Preparation 📋

• Analyzes your package.json and package-lock.json
• Creates a temporary workspace branch in your GitHub repository
• Sets up a GitHub Actions workflow for dependency installation

2. Cloud Installation ☁️

• GitHub Actions runs npm install in the cloud
• Installs all dependencies in parallel
• Creates a node_modules artifact

3. Fast Download 📥

• Downloads the node_modules artifact
• Extracts it to your local machine
• Cleans up temporary files

4. Ready to Code 🎉

• Your node_modules are ready to use
• No waiting, no slow downloads
• Just pure NodeBeam speed!

🛠️ Requirements

• Node.js 14+
• Git installed and configured
• GitHub account with personal access token
• Internet connection (for initial setup)
• npm (for global installation)

🤝 Contributing

Want to help make NodeBeam even better? Here's how you can contribute:

• Fork the repository
• Create a feature branch (git checkout -b feature/amazing-feature)
• Commit your changes (git commit -m 'Add amazing feature')
• Push to the branch (git push origin feature/amazing-feature)
• Open a Pull Request

Development Setup

# Clone and setup
git clone https://github.com/theajmalrazaq/nodebeam.git
cd nodebeam

# Install dependencies
npm install

# Link for development
npm link

# Run tests
npm test

# Start development
npm run dev

📝 License

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

🙏 Acknowledgments

• GitHub Actions - For the powerful CI/CD platform
• Node.js Community - For the amazing ecosystem

🚀 Support

Having trouble with NodeBeam? Here are some resources:

• 🐛 Issues: GitHub Issues
• 💬 Discussions: GitHub Discussions
• 📧 Email: [e-mail]

NodeBeam - Delivering dependencies at the speed of light! 🚀✨

NodeBeam - Your Fast Dependency Delivery System