Desktop PWA Ready Product Information Management Platform
Installation
1) Startup
Clone project repository to your local directory:
git clone [email protected]:ergonode/frontend.gitInstall project dependencies:
npm installSet your local .env file:
npm run envYou may want to override created .env file by other settings
2) Module configuration
Follow CLI steps to configure project:
npm run modulesYou might want automatically setup all modules by executing command:
npm run modules:allAll available modules can be found in the
package.jsonfile in the_availableModulessection, and required modules in the_requiredModulessection.
The
_availableModulesis an object where the key is the module name and the value is the module type. Thelocaltype defines local modules located in themodulesdirectory, and thenpmtype defines modules hosted on npm.
3) Build
Run development mode
npm run devRun production mode
npm run build
npm run startAfter 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 devs.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.