Built With

Getting Started

To get a local copy up and running, please follow these simple steps.

Prerequisites

Here is what you need to be able to run @prismix/orbit.

  • Node.js
  • Yarn (recommended)

Development

Setup

  1. Clone the repo

    git clone https://github.com/prismixapp/orbit.git

  2. Go to the project folder

    cd prismix

  3. Install packages with yarn

    yarn

  4. Start a development instance

    yarn dev

Roadmap

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

Contributing

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

  1. Fork the project
  2. Clone your fork
  3. Create your feature branch (git checkout -b feature/AmazingFeature)
  4. Make your changes
  5. Commit your changes (git commit -m 'Add some AmazingFeature')
  6. Push to the branch (git push origin feature/AmazingFeature)
  7. Open a pull request

License

Distributed under the AGPLv3 License. See LICENSE for more information.

Acknowledgements

Special thanks to these amazing projects which help power Prismix: