diff --git a/.dockerignore b/.dockerignore index 30b8367a4..a23612ce9 100644 --- a/.dockerignore +++ b/.dockerignore @@ -1,17 +1,9 @@ **/.git/* .idea/* +.vscode/* **/.DS_Store dist -docs -pocs -aws-deploy -scripts -slack-integration **/node_modules/* -**/.gradle/* - -submodules/**/build/** -dist/build/node_modules/** diff --git a/DEVELOPER.md b/DEVELOPER.md deleted file mode 100644 index 56e5b6d80..000000000 --- a/DEVELOPER.md +++ /dev/null @@ -1,63 +0,0 @@ -# Developer - -## Running Tests Locally - -### Before running the tests - -Make sure your dependencies are up to date: - -```sh -yarn install -``` - -### Running the tests - -From the project root: - -```sh -yarn test -``` - -This will run the unit test for all the sub packages. - -### Running tests for a single subpackage - -From the project root: - -```sh -yarn test -``` - -For example - -```sh -yarn test server -``` - -## Customize the server environment - -Before starting the server copy and rename the [`.env.example`](/.env.example) to `.env`. Add or modify/uncomment -the environment variables defined in created `.env` file. - -You can alternatively set regular environment variables the way your OS supports them. - -## Other tasks - -All the commands listed in the following subsections are specified as `: description` and they can be run from -the root of the project as: - -```sh -yarn run -``` - -### Managing engine/local data - -- `clean:local`: Clean ALL your local data. This will remove the engine, database and logs. -- `clean:engines`: Remove the local engines only. This will force the server to rebuild the engine on next startup. - -### Misc - -- `update-global-flogo`: Update global flogo-cli to the latest available - -Flogo Web uses npm/yarn scripts for its build process. Take a look at README.md of the packages as well as at the scripts section -in the `package.json` of the root project and the subpackages to find other commands available. diff --git a/docs/client-code-guideline.md b/docs/client-code-guideline.md deleted file mode 100644 index 03a4a5af3..000000000 --- a/docs/client-code-guideline.md +++ /dev/null @@ -1,45 +0,0 @@ -# Client application coding guidelines - -A style guide for syntax, conventions, and structuring Angular applications - -### Style Guides for Reference - -Refer to the following style guides if need be: - -- [JavaScript Style Guide](https://google-styleguide.googlecode.com/svn/trunk/javascriptguide.xml) -- [HTML/CSS Style Guide](https://google-styleguide.googlecode.com/svn/trunk/htmlcssguide.xml) -- [Angular Style Guide](https://angular.io/guide/styleguide) - -## Guidelines for Developers - -### Javascript - -Client code mostly follows the official [Angular Style Guide](https://angular.io/guide/styleguide). Additional -considerations are detailed below. - -#### One component, directive, service, filter... per file, and add meaningful suffix. - -**Valid Suffix** - -1. component -2. directive -3. service -4. pipe -5. spec -6. lang -7. e2e -8. interface -9. model - -When you define class, you also need to add `Component`, `Directive`... as suffix - -#### Unit and Integration tests - -Read [angular's official testing guide](https://angular.io/guide/testing) and about the [different types of testing](https://vsavkin.com/three-ways-to-test-angular-2-components-dcea8e90bd8d). - -DO NOT import the TranslateModule directly, instead use the [language testing utilities](/flogo/core/language/testing) under `@flogo-web/lib-client/core/language/testing`. - -## Reference - -1. [https://mgechev.github.io/angular2-style-guide/](https://mgechev.github.io/angular2-style-guide/) -2. [Angular Style Guide](https://angular.io/guide/styleguide) diff --git a/docs/important-jsons-behaviour.md b/docs/important-jsons-behaviour.md deleted file mode 100644 index c250ba135..000000000 --- a/docs/important-jsons-behaviour.md +++ /dev/null @@ -1,54 +0,0 @@ -# Important JSON structures - -## Things to remember -- The actions as per flogo engine are also known as "flows" in flogo-web -- The diagram component in flow designer page depends on a different JSON structure rather than the normal action's JSON structure. So we depend on a ui-model-converter service which will convert the acion's JSON to the required format - -## Action's "name" property in Application JSON -As per flogo engine the name property of actions are not mandatory and are to be placed in the following path: -``` -"actions": [ - { - "id": "test_flow", - "ref": "github.com/project-flogo/flow", - "data": { - "flow": { - "name": "Test Flow", <--- Here - "type": 1, - "attributes": [], - "rootTask": { - "id": 1, - ... - } - } - } - } - ] -``` - -But flogo-web required the flow names at the action's root definition as follows: -``` -"actions": [ - { - "id": "test_flow", - "ref": "github.com/project-flogo/flow", - "name": "Test Flow", <--- Here - "data": { - "flow": { - "type": 1, - "attributes": [], - "rootTask": { - "id": 1, - ... - } - } - } - } - ] -``` -For this reason, when user imports an application we will set the action's name at it's root level taking the priority as follows: -1. `/data/flow/name` -2. `/name` -3. `/id` (A case where the name is not set for an action. We will set the name with id of the action) - -When user exports an application we will move the `name` attribute from root level to the `data.flow` level. \ No newline at end of file