Skip to content

Latest commit

 

History

History
48 lines (31 loc) · 3.26 KB

README.md

File metadata and controls

48 lines (31 loc) · 3.26 KB
Raw

FINOS - Incubating Maven Central Build CI Security Rating Bugs

legend-engine

Execution engine for Legend. It provides:

  • A Pure parser and compiler.
  • An execution engine, generating and/or executing execution plans when provided with a Pure function, a Mapping and a Runtime.
  • Access point for model transformers written using the Pure language (soon to come).

Development setup

  • This applications uses Maven 3.6+ and JDK 11. Simply run mvn install to compile.
  • In order to start the server, please use the Main class org.finos.legend.engine.server.Server with the parameters: server legend-engine-server/src/test/resources/org/finos/legend/engine/server/test/userTestConfig.json.
  • You can test by trying http://127.0.0.1:6300 in a web browser. The swagger page can be accessed at http://127.0.0.1:6300/api/swagger

Given the size of the project, developers should consider using paralellism to speed up build times, given enough RAM is provided. In IntelliJ IDEA, this can be done by setting Thread Count (in Preferences > Build, Execution, Deployment > Build Tools > Maven) and Shared build process heap size (Mbytes) (in Preferences > Build, Execution, Deployment > Compiler > Java Compiler). For example, setting Thread Count to 4 and Shared build process heap size (Mbytes) to 30000 can significantly reduce build times, you need to fine-tune this to match your machine's specs.

⚠️ It's also important to disable Clear output directory on rebuild in Preferences > Build, Execution, Deployment > Complier as this blows away generated resources needed for running the servers from the IDE.

Starting Pure IDE

If you're making changes to the Pure codebase, it's highly recommended that you also spin up our Pure IDE application:

  • In order to start the server, please use the Main class org.finos.legend.engine.ide.PureIDELight with the parameters: server legend-engine-pure-ide-light/src/main/resources/ideLightConfig.json.
  • You can now access the IDE at http://127.0.0.1:9200/ide in a web browser.

Roadmap

Visit our roadmap to know more about the upcoming features.

Contributing

Visit Legend Contribution Guide to learn how to contribute to Legend.

License

Copyright 2020 Goldman Sachs

Distributed under the Apache License, Version 2.0.

SPDX-License-Identifier: Apache-2.0