Skip to content

Commit

Permalink
#207 Backend Frontend separation
Browse files Browse the repository at this point in the history
- fixing errors due to renaming of frontend and backend folder in README.md and CONTRIBUTING.md
  • Loading branch information
MaximilianZenz committed Jan 15, 2024
1 parent 876d69b commit 07fa549
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 9 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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`
Expand Down
13 changes: 6 additions & 7 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```


Expand All @@ -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
Expand Down Expand Up @@ -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)
Expand Down

0 comments on commit 07fa549

Please sign in to comment.