diff --git a/README.md b/README.md index 70ab247bc..8b6670c81 100644 --- a/README.md +++ b/README.md @@ -120,7 +120,7 @@ A sample configuration file looks like this: You may override configuration options for specific projects by placing another `.binocularrc` file in the project's root directory. -You may also modify a config to the `gitlab.json` file in `./ui/config`. This file sets +You may also modify a config to the `gitlab.json` file in `./binocular-frontend/config`. This file sets the GitLab API settings for the CodeHotspots-visualization for offline execution. This is only necessary if you want to automatically set those options within, for example, a GitLab pipeline. @@ -172,7 +172,7 @@ npm run build ``` This will create an html and js file in the dist folder that can be opened without the backend running. It is also possible -to place the exported JSON files of a different mining job under `./ui/db_export/` and build the frontend. (not +to place the exported JSON files of a different mining job under `./binocular-frontend/db_export/` and build the frontend. (not all features will be available in the offline build) For more information check `binocular -h` diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index c07e8065b..830993997 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -29,10 +29,9 @@ The source-code is organized similarly: ``` Binocular -├── foxx # Holds the foxx-service that is the GraphQL-interface -├── lib # Holds the back-end -├── tests # Unit tests -└── ui # Holds the front-end +├── foxx # Holds the foxx-service that is the GraphQL-interface +├── binocular-backend # Holds the back-end +└── binocular-frontend # Holds the front-end ``` @@ -42,11 +41,11 @@ The back-end is a pretty straightforward node.js application. It is responsible for gathering data and uses express to host the front-end. The data gathering is done by a type of component called indexer. You -can see the indexers in the `lib/indexers` directory: +can see the indexers in the `binocular-backend/indexers` directory: ``` -lib/indexers +binocular-backend/indexers ├── BaseGitLabIndexer.js # Basic indexer for accessing GitLab-Data ├── ci # CI-specific indexers │   ├── GitLabCIIndexer.js # Indexer for GitLab-CI @@ -80,7 +79,7 @@ The front-end is a redux-backed react application that heavily relies on D3 to do its work: ``` -ui +binocular-frontend ├── index.html # Main entry point ├── config # Aditional config files for the fronted (mainly used for automatic builds) ├── db_export # Folder for the json export of the databse for offline use (will be automatically generated during the first execution)