-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #58 from Flux-Coordinator/develop
Merge develop into master
- Loading branch information
Showing
127 changed files
with
4,328 additions
and
1,162 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,29 +1,43 @@ | ||
| # Flux-Frontend | ||
|
|
||
| <div align="center"> | ||
| [](https://github.com/facebook/jest) | ||
| [](https://github.com/Flux-Coordinator/flux-frontend) | ||
| [](https://sonarcloud.io/api/project_badges/measure?project=flux-frontend&metric=reliability_rating) | ||
| [](https://sonarcloud.io/api/project_badges/measure?project=flux-frontend&metric=coverage) | ||
| [](https://sonarcloud.io/api/project_badges/measure?project=flux-frontend&metric=alert_status) | ||
| [](https://travis-ci.org/Flux-Coordinator/flux-frontend) | ||
| [](https://github.com/prettier/prettier) | ||
| [](https://david-dm.org/Flux-Coordinator/flux-frontend) | ||
| [](https://david-dm.org/Flux-Coordinator/flux-frontend?type=dev) | ||
| [](https://david-dm.org/Flux-Coordinator/flux-frontend?type=peer) | ||
|
|
||
| [](https://github.com/facebook/jest) | ||
| [](https://github.com/Flux-Coordinator/flux-frontend) | ||
| [](https://sonarcloud.io/api/project_badges/measure?project=flux-frontend&metric=reliability_rating) | ||
| [](https://sonarcloud.io/api/project_badges/measure?project=flux-frontend&metric=coverage) | ||
| [](https://sonarcloud.io/api/project_badges/measure?project=flux-frontend&metric=alert_status) | ||
| [](https://travis-ci.org/Flux-Coordinator/flux-frontend) | ||
| [](https://github.com/prettier/prettier) | ||
| [](https://david-dm.org/Flux-Coordinator/flux-frontend) | ||
| [](https://david-dm.org/Flux-Coordinator/flux-frontend?type=dev) | ||
| [](https://david-dm.org/Flux-Coordinator/flux-frontend?type=peer) | ||
|
|
||
| </div> | ||
|
|
||
| ## Ordnerstruktur | ||
| ## How to run this application in development mode | ||
|
|
||
| Follow the guide below to run this application in development mode. | ||
| **Prerequisites:** [NodeJS 8](https://nodejs.org/en/download/) and [Yarn](https://yarnpkg.com/en/docs/install) (recommended) or NPM. | ||
|
|
||
| 1. Download the repository | ||
| 2. Install the dependencies using `yarn` or `npm install` | ||
| 3. Run the application using the `yarn start` or the `npm run start` command. | ||
|
|
||
| The URI for the connection to the [flux-server](https://github.com/Flux-Coordinator/flux-server) instance needs to be set either as an environment variable named `REACT_APP_SERVICE_URI` or using a [_.env_](https://github.com/motdotla/dotenv) file, in which you have the following content: | ||
|
|
||
| ``` | ||
| REACT_APP_SERVICE_URI = <sever_uri> | ||
| ``` | ||
|
|
||
| ## Run in Production Mode | ||
|
|
||
| To run this application in production mode, you need to build it first, using the `yarn build` or `npm run build` command. After the command has run through, you will find the built application in the _/build_ folder. You can deploy that folder on your preferred static webserver or using [serve](https://github.com/zeit/serve). | ||
|
|
||
| To install serve globally, you can use the `yarn global add serve` or `npm install -g serve`. After the installation is complete, you can use the command `serve -s build`, where build the _/build_ folder. | ||
|
|
||
| If you use a webserver other than serve, you will need to make some changes. Follow the guide [here](https://github.com/facebook/create-react-app/blob/master/packages/react-scripts/template/README.md#serving-apps-with-client-side-routing). | ||
|
|
||
| Die Ordnerstruktur im **./src** Ordner sieht wie folgt aus: | ||
| ## More informations | ||
|
|
||
| | Ordner | Beschreibung | | ||
| | -------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | src/api | Die JS Dateien in diesem Ordner stellen die Anfragen an das backend API. | | ||
| | src/components | In diesem Ordner befinden sich die Presentational Components. Merke, dass die CSS und Tests ebenfalls in diesem Ordner zusammen mit ihren Components befinden. | | ||
| | src/containers | In diesem Ordner befinden sich die Container Components. Diese machen die API Calls und besitzen einen State. Merke, dass die CSS und Tests ebenfalls in diesem Ordner zusammen mit ihren Components befinden. | | ||
| | src/images | Hier befinden sich die Bilder, die in der Anwendung verwendet werden. | | ||
| | src/index.jsx | In dieser Datei wird die App initialisiert. | | ||
| | src/utils | Alles, was sonst nicht eingeordnet werden kann und keinen eigenen Ordner verdient. | | ||
| For more information about running and deploying the application, you can consult the CRA documentation [here](https://github.com/facebook/create-react-app/blob/master/packages/react-scripts/template/README.md). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,104 @@ | ||
| // flow-typed signature: 1becce44f344e7ddc91c138bd08004b8 | ||
| // flow-typed version: <<STUB>>/@flux-coordinator/heatmapjs_v^2.1.4/flow_v0.73.0 | ||
|
|
||
| /** | ||
| * This is an autogenerated libdef stub for: | ||
| * | ||
| * '@flux-coordinator/heatmapjs' | ||
| * | ||
| * Fill this stub out by replacing all the `any` types. | ||
| * | ||
| * Once filled out, we encourage you to share your work with the | ||
| * community by sending a pull request to: | ||
| * https://github.com/flowtype/flow-typed | ||
| */ | ||
|
|
||
| declare module "@flux-coordinator/heatmapjs" { | ||
| declare module.exports: any; | ||
| } | ||
|
|
||
| /** | ||
| * We include stubs for each file inside this npm package in case you need to | ||
| * require those files directly. Feel free to delete any files that aren't | ||
| * needed. | ||
| */ | ||
| declare module "@flux-coordinator/heatmapjs/build/heatmap" { | ||
| declare module.exports: any; | ||
| } | ||
|
|
||
| declare module "@flux-coordinator/heatmapjs/build/heatmap.min" { | ||
| declare module.exports: any; | ||
| } | ||
|
|
||
| declare module "@flux-coordinator/heatmapjs/docs/assets/js/prism" { | ||
| declare module.exports: any; | ||
| } | ||
|
|
||
| declare module "@flux-coordinator/heatmapjs/plugins/angular-heatmap/angular-heatmap" { | ||
| declare module.exports: any; | ||
| } | ||
|
|
||
| declare module "@flux-coordinator/heatmapjs/plugins/boilerplate" { | ||
| declare module.exports: any; | ||
| } | ||
|
|
||
| declare module "@flux-coordinator/heatmapjs/plugins/gmaps-heatmap/gmaps-heatmap" { | ||
| declare module.exports: any; | ||
| } | ||
|
|
||
| declare module "@flux-coordinator/heatmapjs/plugins/leaflet-heatmap/leaflet-heatmap" { | ||
| declare module.exports: any; | ||
| } | ||
|
|
||
| declare module "@flux-coordinator/heatmapjs/plugins/segment-heatmap" { | ||
| declare module.exports: any; | ||
| } | ||
|
|
||
| declare module "@flux-coordinator/heatmapjs/plugins/svg-area-heatmap" { | ||
| declare module.exports: any; | ||
| } | ||
|
|
||
| // Filename aliases | ||
| declare module "@flux-coordinator/heatmapjs/build/heatmap.js" { | ||
| declare module.exports: $Exports<"@flux-coordinator/heatmapjs/build/heatmap">; | ||
| } | ||
| declare module "@flux-coordinator/heatmapjs/build/heatmap.min.js" { | ||
| declare module.exports: $Exports< | ||
| "@flux-coordinator/heatmapjs/build/heatmap.min" | ||
| >; | ||
| } | ||
| declare module "@flux-coordinator/heatmapjs/docs/assets/js/prism.js" { | ||
| declare module.exports: $Exports< | ||
| "@flux-coordinator/heatmapjs/docs/assets/js/prism" | ||
| >; | ||
| } | ||
| declare module "@flux-coordinator/heatmapjs/plugins/angular-heatmap/angular-heatmap.js" { | ||
| declare module.exports: $Exports< | ||
| "@flux-coordinator/heatmapjs/plugins/angular-heatmap/angular-heatmap" | ||
| >; | ||
| } | ||
| declare module "@flux-coordinator/heatmapjs/plugins/boilerplate.js" { | ||
| declare module.exports: $Exports< | ||
| "@flux-coordinator/heatmapjs/plugins/boilerplate" | ||
| >; | ||
| } | ||
| declare module "@flux-coordinator/heatmapjs/plugins/gmaps-heatmap/gmaps-heatmap.js" { | ||
| declare module.exports: $Exports< | ||
| "@flux-coordinator/heatmapjs/plugins/gmaps-heatmap/gmaps-heatmap" | ||
| >; | ||
| } | ||
| declare module "@flux-coordinator/heatmapjs/plugins/leaflet-heatmap/leaflet-heatmap.js" { | ||
| declare module.exports: $Exports< | ||
| "@flux-coordinator/heatmapjs/plugins/leaflet-heatmap/leaflet-heatmap" | ||
| >; | ||
| } | ||
| declare module "@flux-coordinator/heatmapjs/plugins/segment-heatmap.js" { | ||
| declare module.exports: $Exports< | ||
| "@flux-coordinator/heatmapjs/plugins/segment-heatmap" | ||
| >; | ||
| } | ||
| declare module "@flux-coordinator/heatmapjs/plugins/svg-area-heatmap.js" { | ||
| declare module.exports: $Exports< | ||
| "@flux-coordinator/heatmapjs/plugins/svg-area-heatmap" | ||
| >; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.