Desktop PWA Ready Product Information Management Platform

Welcome to the world of Ergonode :)

Ergonode is an open-source project of a new Product Information Management system (PIM). We have set ourselves the goal of building a completely new system from scratch, which will be able to easily out-of-the box handle 100k+ product references, and in addition will provide maximum user satisfaction with product management.

It is a system that can be easily integrated with many popular e-commerce platforms (Magento, Shopware, PrestaShop, Shopify, Sylius, etc.).

Ergonode will be always full open-source project. Currently, the system is in the phase of product catalog stabilization and import. We invite all developers who want to develop a new quality of shopping experience with us, we are open to contributors and support, because the project is not developed by large team (we are small but extraordinary team of designers, programmers and product managers).

If you are a new developer and need help, feel-free to ask questions our core team on our slack channel.

@Marcin Piwowarczyk (product vision and strategy)

@Rafal Przedzik (backend architecture and integrations)

@Maciej Kaczorowski (frontend architecture)

@Piotr Bletek (frontend architecture)

@Mateusz Kolankowski (documentation and backend support)

@Marcin Warzynski (product requirements management)

We are looking for core team members who willing to support us and help Ergonode awesome software. Interested? Contact to @Marcin Piwowarczyk on slack.

At the moment we prepare full list contribution rules, to support devs before making any pull request. Pull request that doesn't meet these rules will not be merged and included to core functions.

Ergonode awesome functions

Grid Management

Ergonode is first and foremost an efficient environment for managing products from the list level. The solution enables you to filter and edit hundreds of products at once at any time, thanks to which mass content editing becomes pleasant and convenient. The system is easy to use, yet it has the capabilities of a spreadsheet.

In Ergonode you can edit and translate products information directly from spreadsheet view. Moving around cells is now fast and comfortable by supporting simple keyboard shortcuts.

Filtering products

Ergonode lets you to easily manage spreadsheet columns by simple drag and drop actions. The system allows you to adjust the appearance of the products spreadsheet to suit their needs and preferences.

The solution allows you to filter products information at any time by choosing any attributes and preferences you want.

Product Template Designer

Ergonode allows you to create any feature describing the product. You can create attributes that are text fields for filling in, single and multi-selection fields, as well as complex features such as price or unit.

All of this, included in a simple and intuitive wizard, allows you to create any structure of the product sheet.

System Architecture

From the very beginning, Ergonode was designed to provide maximum satisfaction not only for product and conent managers, but especially for developers.

The system architecture was built entirely based on Domain Driven Design approach using Command Query Responsibility Segregation (CQRS) and Event Sourcing.

Thanks to this, we have gained unprecedented flexibility in managing every element of the system from the moment of its creation and a trouble-free division/exchange of databases in individual areas of the system.

The system consists of two main independent Backend and Frontend applications, which communicate with each other through the RestAPI interface.

On the front side we've used headless approach with Vue.js application. Thanks to that we have gained an increase in the performance and speed of the application, as well as the readiness to fully adapt the system as a Desktop Progressive Web App.

Backend Technologies

• PHP 7.2
• Symfony 4.1
• Postgres 9.6 (uuid-ossp, ltree)
• RabbitMQ
• Redis
• Elasticsearch
• Nginx (possible Apache)
• MongoDB (optional)

Front-End Technologies

• Vue.js
• Nuxt.js
• Node.js
• SASS
• Axios
• BEM (CSS)
• ESLint (Airbnb standard)

Tests

• Phpunit
• Behat (API)
• JestJS

Domain Driven Design Approach

• CQRS
• ES
• SAGA
• EVENT BUS

Instalation

Download project repository (ergonode) to your local directory:

git clone [email protected]:ergonode/frontend.git

Open your terminal in local project, and execute:

npm install

Execute CLI command and set you API URL:

npm run cli:run

You can also copy .env.dist file as .env and set your API URL configuration.

Run server

#development
npm run dev

#production
npm run build
npm run start

Build with us community on Slack

If you have any questions or ideas feel free to join our slack.

Is it production ready?

No! At the moment we have only one testing implementation to production environment (with more than 150k+ product indexes and integration with Magento Commerce 2.3), but in our opinion system still needs to be stabilised and we recommend not to use it at the moment in production mode. We still develop the core and there could be a lot of changes in the near future. If you want to know when it will be production ready look at Ergonode Roadmap.

Documentation

The project is in early stage and we have got a lot of milestones to develop. We do our best to deliver great documentation, but - to be honest - it is the hardest thing in open-source projects :)

Please find out what we've already prepared on docs.ergonode.com

Roadmap

If you would like to find the current and future milestones for our project go to our Roadmap page.

At the moment we finalize development of Milestone 1 of the project.

Build Ergonode with us!

We are looking for Contributors: Back-end Dev, JS Devs, Tech Writers and Designers. Please read our contribution rules before making any pull request. If you have any questions or ideas feel free to join our slack or send us an email: [email protected]

Partners

Ergonode is open-source, and it can be brought to you only by great community and partners supported by our core team. If you want to be on that list please send us an email: [email protected]

The license

Ergonode source code is released under the OSL 3.0 License.