Search by

pronamic / wp-orbis

remcotolsma

There is no license information available for the latest version (1.2.0) of this package.

Orbis is a powerful, extendable plugin to boost up your business. Project Management, Customer Relation Management & More…

Package info

github.com/pronamic/wp-orbis

Homepage

Language:JavaScript

Type:wordpress-plugin

pkg:composer/pronamic/wp-orbis

Statistics

Installs: 15

Dependents: 0

Suggesters: 0

Stars: 12

Open Issues: 0

1.2.0 2014-11-03 08:50 UTC

README

Orbis

Orbis

Run your business on WordPress.
Projects, relations, time tracking, subscriptions and more β€” in one extendable, self-hosted business platform.

License: GPL-2.0-or-later PHP >= 8.0 WordPress >= 5.2 Last commit

Every business is different, so why squeeze yours into someone else's software? Orbis turns your WordPress site into a fully working business tool: an intranet, CRM and project management system in one. You keep your own hosting and your own data, and you add exactly the features you need with Orbis plugins.

Orbis is built and used every day by Pronamic to run its own agency: projects, customers, hours, hosting subscriptions and invoices all live in Orbis.

Table of contents

Why Orbis?

  • 🧩 Modular. Start with the core and switch on only the plugins you need: projects, timesheets, deals, subscriptions, invoices and more.
  • 🏠 Your data, your server. Orbis runs in your own WordPress installation. No SaaS subscription, no vendor lock-in.
  • πŸ› οΈ Built on WordPress. Post types, comments, revisions, users, roles and the REST API β€” everything you already know just works.
  • πŸ”Œ Connects to your tools. Integrations for Slack, Twinfield, SiteGround, Openprovider and more.
  • 🌍 Translatable. Fully translatable, with Dutch (nl_NL) included.
  • πŸ’š Free and open source. Licensed under GPL-2.0-or-later.

Features

The core plugin provides the foundation that all Orbis plugins build on:

  • Orbis admin menu with a dashboard, settings, stats and a plugins page to install and activate Orbis plugins.
  • Teams (orbis_team) to group users and connect them to pages, posts and projects.
  • Access control that limits content to the members of the connected teams.
  • Roles and capabilities such as manage_orbis to control who can use Orbis.
  • Email updates on a configurable schedule, with hooks to add your own content.
  • vCards for organizations and contacts via the /vcard/ endpoint.
  • Currency settings and money formatting via pronamic/wp-money.
  • Autocomplete for persons and organizations in the admin, powered by Select2.
  • Posts 2 Posts integration to connect Orbis content to each other.

Orbis plugins

The real power of Orbis lies in its plugins. Combine them to build the business tool that fits you.

Relations

Plugin Description
Orbis Contacts Shared contact layer for persons and organizations: email addresses, phone numbers, social accounts and relations.
Orbis Organizations Manage companies, associations, foundations and more, and link them to projects, persons and subscriptions.
Orbis Persons Manage persons with personal details such as birth date and gender.

Work

Plugin Description
Orbis Projects Manage projects and connect them to organizations.
Orbis Tasks Add tasks and connect them to projects.
Orbis Timesheets Track your work time and register hours on projects.
Orbis Keychains Share login details with your team and log who used them, and why.

Sales and finance

Plugin Description
Orbis Deals Keep track of deals, deal lines and their status: pending, won or lost.
Orbis Subscriptions Manage subscription products and recurring subscriptions.
Orbis Twinfield Synchronize Orbis information to Twinfield.

Hosting and integrations

Plugin Description
Orbis SiteGround Compare SiteGround hosting accounts and websites against Orbis subscriptions.
Orbis Openprovider Check domain names against Orbis subscriptions.
Orbis Monitoring Monitor websites from Orbis.
Orbis Slack Integrate Orbis with Slack.

Theme

Theme Description
Orbis 5 The front-end theme for Orbis, powered by Bootstrap 5.3.

Requirements

Installation

  1. Build the plugin with composer build (see Development), or download it from the Pronamic WordPress Directory.
  2. Upload orbis.zip via Plugins β†’ Add New β†’ Upload Plugin in WordPress and activate it.
  3. Go to Orbis β†’ Plugins to add the features you need.
  4. Install the Orbis theme for a complete front-end experience.

REST API

The plugin registers routes in the orbis/v1 namespace:

Method Route Description
GET /wp-json/orbis/v1/users/by?email={email} Get a user by email address.
GET /wp-json/orbis/v1/users/{id} Get a user by ID.

Development

Clone the repository and install the dependencies:

git clone https://github.com/pronamic/wp-orbis.git
cd wp-orbis
composer install
npm install

Start a local WordPress environment with @wordpress/env. It installs Posts 2 Posts, Pronamic Client, Query Monitor and other development plugins:

npx wp-env start

Composer scripts

Command Description
composer phpcs Check the code against the Pronamic coding standards.
composer phpcbf Automatically fix coding standard violations.
composer rector Refactor the code with Rector.
composer build Build the plugin and create a distribution archive in build/.
composer make-pot Update the .pot and .po translation files.
composer deploy Deploy the plugin with Deployer.

Links

Made with πŸ’™ by Pronamic Β· GPL-2.0-or-later