@stackone/hub
v0.11.1
Published
StackOne HUB
Keywords
Readme
StackOne HUB
⚠️ ALPHA SOFTWARE ⚠️
This project is currently in alpha stage. Features are incomplete, and may break without notice. Use in production environments is not recommended.
StackOne HUB is a React-based integration component library that provides a web component wrapper for seamless integration into any web application. It enables developers to easily embed StackOne's integrations hub.
📋 Table of Contents
- StackOne HUB
⚠️ Alpha Notice
This software is in active development and should be considered alpha quality.
- 🚧 Breaking changes may occur in any release
- 🐛 Bugs and incomplete features are expected
- 📚 Documentation may be outdated or incomplete
- 🔄 APIs are subject to change without prior notice
- ❌ Not recommended for production use
Please report issues and provide feedback to help us improve!
🚀 Quick Start
# Clone and setup
git clone <repository-url>
cd hub
npm install
npm run build
# Start development
npm run dev📦 Installation
Prerequisites
Setup
Clone the repository:
git clone <repository-url> cd hubInstall dependencies:
npm installBuild the project:
npm run build
🛠️ Development
Environment Setup
Create environment file:
cp .env.example .envConfigure your environment variables (see Environment Variables section)
Start the development server:
npm run dev
The development server will start at http://localhost:3000 (default port).
🏗️ Build
To build the project for production:
npm run buildBuild Output
The build generates multiple bundles in the dist/ directory:
| File | Description | Use Case |
|------|-------------|----------|
| StackOneHub.esm.js | ES module bundle | Modern React applications |
| StackOneHub.cjs.js | CommonJS module | Node.js/legacy environments |
| StackOneHub.web.js | Web component bundle | Vanilla HTML/JS integration |
📖 Usage
🌐 Web Component Integration
For vanilla HTML/JavaScript applications:
<!DOCTYPE html>
<html>
<head>
<title>StackOne HUB Integration</title>
</head>
<body>
<script src="<TBD>/StackOneHub.web.js"></script>
<my-component></my-component>
</body>
</html>⚛️ React Component Integration
For React applications:
import StackOneHub from "@stackone/StackOneHub";
function App() {
return (
<div className="app">
<h1>My Application</h1>
<StackOneHub />
</div>
);
}
export default App;💻 Local Development Usage
Web Component (Local)
<script src="dist/StackOneHub.web.js"></script>
<my-component></my-component>React Component (Local)
import StackOneHub from "dist/StackOneHub.esm";
function App() {
return <StackOneHub />;
}🔧 Environment Variables
Create a .env file in the dev directory with the following variables:
| Variable | Description | Required |
|----------|-------------|----------|
| STACKONE_API_KEY | Your StackOne API key | ✅ |
| ORIGIN_OWNER_ID | The origin owner identifier | ✅ |
| ORIGIN_OWNER_NAME | Display name for the owner | ✅ |
| ORIGIN_USERNAME | Username for authentication | ✅ |
| API_URL | Backend API endpoint URL | ✅ |
| DASHBOARD_URL | Dashboard application URL | ✅ |
Example .env file:
STACKONE_API_KEY=your_api_key_here
ORIGIN_OWNER_ID=your_owner_id
ORIGIN_OWNER_NAME=Your Company Name
ORIGIN_USERNAME=your_username
API_URL=https://api.stackone.com
DASHBOARD_URL=https://dashboard.stackone.com🤝 Contributing
Since this project is in alpha, we welcome contributions and feedback! However, please keep in mind:
- 🔄 Frequent changes: The codebase may change rapidly
- 📋 No formal process yet: Contribution guidelines are still being established
- 💬 Communication is key: Please open an issue before submitting large changes
Getting Started
- Fork the repository
- Create a feature branch
- Make your changes
- Test thoroughly
- Submit a pull request
📄 License
This project is licensed under the MIT License. See the LICENSE file for details.