Skip to content

Latest commit

 

History

History
73 lines (49 loc) · 2.06 KB

README.md

File metadata and controls

73 lines (49 loc) · 2.06 KB

This project was created to build an interactive graph displaying Liferay's database relationships on schema modules.

DEMO -> Here

Requirements

  • Node >= 10.x
  • Yarn >= 0.10.x

We use the following technologies:

For the cli side:

  • Fìglet
  • Chalk
  • Inquirer

For the script side:

* fdir
* fs
* rimraf
* xml2js

For the diagrams side mainly:

  • React / React-dom (License)
  • three-spritetext (License)
  • react-force-graph (License)
  • eslint
  • babel
  • webpack
  • And a lot of other libs, you can find Here
  • and Yarn workspaces to rule them all

Available Scripts

In the main project directory, you can run firstly:

yarn cli

to run the models generator.

The generator will ask you

  1. to type/paste the Liferay's project path
  2. to choose which path you want to crawl to extrapolate the models from

If all goes well you can run

yarn diagram

to start the site in devoplent mode http://localhost:3000 to view it in the browser). The page will reload if you make edits.
You will also see any lint errors in the console

otherwise

yarn build

to build the static files contained in /diagram-db-react/build folder. It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

To make it works run it twice 😞

Edit: The json's generation now should be fixed.
If the diagram doesn't appear, try to run it twice anyway. If it doesn't works report to me and i'll fix the issue.