👉 BETA SOFTWARE This project is currently in beta stage. It is evolving quickly, and new versions may include breaking changes.
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.
- StackOne HUB
This software is in active development and should be considered beta quality.
- 🚧 Breaking changes may occur in any release
- 📚 Documentation is updated regularly
- 🔄 APIs are subject to change without prior notice
Please report issues and provide feedback to help us improve!
# Clone and setup
git clone <repository-url>
cd hub
npm install
npm run build
# Start development
npm run dev-
Clone the repository:
git clone <repository-url> cd hub
-
Install dependencies:
npm install
-
Build the project:
npm run build
-
Create environment file:
cp .env.example .env
-
Configure 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).
To build the project for production:
npm run buildThe 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 |
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>For React applications:
import StackOneHub from "@stackone/StackOneHub";
function App() {
return (
<div className="app">
<h1>My Application</h1>
<StackOneHub />
</div>
);
}
export default App;<script src="dist/StackOneHub.web.js"></script>
<my-component></my-component>import StackOneHub from "dist/StackOneHub.esm";
function App() {
return <StackOneHub />;
}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 | ✅ |
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.comSince this project is in beta, 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
- Fork the repository
- Create a feature branch
- Make your changes
- Test thoroughly
- Submit a pull request
This project is licensed under the MIT License. See the LICENSE file for details.