[go: up one dir, main page]

Skip to content

TheTechCompany/HexHive

Repository files navigation

Logo

HexHive

The extendable SaaS platform.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

![Product Name Screen Shot][product-screenshot]

Skip the boiletplate, deploy your solution to the world.

(back to top)

Built With

(back to top)

Getting Started

Prerequisites

  • NPM : ^8.3.1
  • Node.js : ^16.13.0
  • Docker : Install
  • Docker Compose : Install

Installation

  npm install @hexhive/cli -g

(back to top)

Usage

Dev Server

Install

hexhive dev
cd micrograph/
yarn start

Starting...
App available at /dashboard/app

Admin will be available at http://localhost:7000/ Visit http://localhost:7000/dashboard/app to see your app.

Gateway GraphQL modules

import { HiveGraph } from '@hexhive/graphql-server';

const graph = new HiveGraph({
  rootServer: `gateway server`
})

graph.start($PORT)

Microfrontend

npx create-single-spa ./app

For more examples, please refer to the Documentation

(back to top)

Roadmap

  • Local development gateway
    • Local registry
    • Local frontend server
    • Local auth/db
  • Federated data
  • Realtime collaboration
  • Shared file system

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the GNU GPL v3 License. See LICENSE.txt for more information.

(back to top)