Skip to content

Latest commit

 

History

History
164 lines (122 loc) · 5.26 KB

README.md

File metadata and controls

164 lines (122 loc) · 5.26 KB
Raw

Ergonode logo

Desktop PWA Ready Product Information Management Platform

Version Code Version Chat Docs License Lerna


Installation

1) Startup

Clone project repository to your local directory:

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

Install project dependencies:

npm install

Set your local .env file:

npm run env

You may want to override created .env file by other settings

2) Module configuration

Follow CLI steps to configure project:

npm run modules

You might want automatically setup all modules by executing command:

npm run modules:all

All available modules can be found in the package.json file in the _availableModules section, and required modules in the _requiredModules section.

The _availableModules is an object where the key is the module name and the value is the module type. The local type defines local modules located in the modules directory, and the npm type defines modules hosted on npm.

3) Build

Run development mode

npm run dev

Run production mode

npm run build
npm run start

After you set up backend application and generated default fixtures you may login into application with credentials [email protected], password: abcd1234

4) Docker

Installation guide at docker repository

Browser

We recommend using the latest version of Chrome browser. On other browsers some functionalities may not work as intended.

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

Technologies

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

Contact us

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

Is it production ready

Yes!

Contributing

Before you start making any pull requests checkout our contribution guide. 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.