-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
Release/2.0.0
- Loading branch information
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
# Contributing | ||
|
||
When contributing to this repository, please consider the following aspects | ||
|
||
## Adding a new Container component | ||
|
||
Container components implement the communication with Redux to obtain the available telemetry/event data. Container components: | ||
1. Should be named `component.container.jsx` | ||
2. Should include and export a `schema` variable with the UIF configuration | ||
3. Should provide a `subscriptions` prop with the telemetry/event subscription list, to be displayed in the telemetry/event raw data | ||
|
||
## Editing the documentation | ||
|
||
The documentation is done with `styleguide`. Its source code is located under `love/docsrc` and compiled to `docs/` according to the configuration file located at `love/styleguide.config.js`. | ||
|
||
1. To edit the docs in a local server run | ||
|
||
``` | ||
docker-compose exec frontend | ||
# inside frontend container | ||
yarn guide:start | ||
``` | ||
and go to the pointed address. | ||
|
||
2. To create a production build in the `docs/` folder run | ||
|
||
``` | ||
docker-compose exec frontend | ||
# inside frontend container | ||
yarn guide:build | ||
``` | ||
|
||
3. Some useful guides to edit the configuration: | ||
|
||
* General configuration | ||
* [Create a new section](https://react-styleguidist.js.org/docs/components.html#sections): | ||
* [Show 1 page per section or 1 page with all sections](https://react-styleguidist.js.org/docs/configuration#pagepersection) | ||
* [Changing the build dir](https://react-styleguidist.js.org/docs/configuration#styleguidedir) | ||
|
||
* Documenting the source code | ||
* [Adding `.md` files for examples, using `jsDocs` for descriptions, `proptypes` and `defaultprops`.](https://react-styleguidist.js.org/docs/documenting.html) | ||
* [Documenting with redux](https://react-styleguidist.js.org/docs/thirdparties.html#redux) | ||
* [Adding static assets](https://react-styleguidist.js.org/docs/configuration#assetsdir) | ||
|
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
FROM node:10.16-alpine as builder | ||
FROM node:12.16.1-alpine as builder | ||
|
||
WORKDIR /usr/src/love/love | ||
|
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
FROM node:12.16.1-alpine as builder | ||
|
||
WORKDIR /usr/src/love | ||
|
||
# Install and cache app dependencies | ||
COPY love/package.json . | ||
COPY love/yarn.lock . | ||
RUN yarn install | ||
|
||
COPY love . | ||
COPY run_tests.sh . | ||
|
||
CMD ["sh", "/usr/src/love/run_tests.sh"] |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,15 +1,28 @@ | ||
{ | ||
"files": { | ||
"main.css": "/static/css/main.25874eb3.chunk.css", | ||
"main.js": "/build/main.7d68979a.js", | ||
"runtime~main.js": "/build/bundle.bcec71db.js", | ||
"build/2.346127f9.js": "/build/2.346127f9.js", | ||
"main.css": "/static/css/main.f1a0019b.chunk.css", | ||
"main.js": "/build/main.98f1ed5e.js", | ||
"runtime-main.js": "/build/bundle.e2439c58.js", | ||
"static/css/2.ee241de9.chunk.css": "/static/css/2.ee241de9.chunk.css", | ||
"build/2.f48525ee.js": "/build/2.f48525ee.js", | ||
"Frontend_overview.svg": "/Frontend_overview.svg", | ||
"build/2.f48525ee.js.LICENSE.txt": "/build/2.f48525ee.js.LICENSE.txt", | ||
"details.svg": "/details.svg", | ||
"index.html": "/index.html", | ||
"precache-manifest.58ac1c8bc09639a9c2e1e40fad8d5f89.js": "/precache-manifest.58ac1c8bc09639a9c2e1e40fad8d5f89.js", | ||
"precache-manifest.9ea304bc0afdc49ab503b923e9031493.js": "/precache-manifest.9ea304bc0afdc49ab503b923e9031493.js", | ||
"redux-script-validation.svg": "/redux-script-validation.svg", | ||
"redux-ws-connection.svg": "/redux-ws-connection.svg", | ||
"responsive-grid-state-machine.svg": "/responsive-grid-state-machine.svg", | ||
"service-worker.js": "/service-worker.js", | ||
"static/css/main.25874eb3.chunk.css.map": "/static/css/main.25874eb3.chunk.css.map", | ||
"static/css/2.ee241de9.chunk.css.map": "/static/css/2.ee241de9.chunk.css.map", | ||
"static/css/main.f1a0019b.chunk.css.map": "/static/css/main.f1a0019b.chunk.css.map", | ||
"static/media/index.css": "/static/media/AvenirLTStd-Light.0b78ec9d.otf" | ||
} | ||
}, | ||
"entrypoints": [ | ||
"build/bundle.e2439c58.js", | ||
"static/css/2.ee241de9.chunk.css", | ||
"build/2.f48525ee.js", | ||
"static/css/main.f1a0019b.chunk.css", | ||
"build/main.98f1ed5e.js" | ||
] | ||
} |
This file was deleted.
Large diffs are not rendered by default.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
/*! For license information please see 2.f48525ee.js.LICENSE.txt */ |
This file was deleted.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
This file was deleted.
Large diffs are not rendered by default.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,17 @@ | ||
<!DOCTYPE html><html><head><meta charset="UTF-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta http-equiv="X-UA-Compatible" content="ie=edge"><title>LOVE-frontend</title><link href="static/css/main.25874eb3.chunk.css" rel="stylesheet"></head><body><div id="rsg-root"></div><script src="build/bundle.bcec71db.js"></script><script src="build/2.346127f9.js"></script><script src="build/main.7d68979a.js"></script></body></html> | ||
<!DOCTYPE html> | ||
<html> | ||
<head> | ||
<meta charset="utf-8"> | ||
<meta name="viewport" content="width=device-width, initial-scale=1.0"> | ||
<meta http-equiv="X-UA-Compatible" content="ie=edge"> | ||
<title>LOVE-frontend</title> | ||
<link rel="stylesheet" href="static/css/2.ee241de9.chunk.css"> | ||
<link rel="stylesheet" href="static/css/main.f1a0019b.chunk.css"> | ||
</head> | ||
<body> | ||
<div id="rsg-root"></div> | ||
<script src="build/bundle.e2439c58.js"></script> | ||
<script src="build/2.f48525ee.js"></script> | ||
<script src="build/main.98f1ed5e.js"></script> | ||
</body> | ||
</html> |
This file was deleted.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
self.__precacheManifest = (self.__precacheManifest || []).concat([ | ||
{ | ||
"revision": "2b0b770b5af3bf18d864eb1ff915429d", | ||
"url": "Frontend_overview.svg" | ||
}, | ||
{ | ||
"revision": "f48525ee19473056dbb9", | ||
"url": "build/2.f48525ee.js" | ||
}, | ||
{ | ||
"revision": "d48274c60eb4e51c3e46d1d3be176614", | ||
"url": "build/2.f48525ee.js.LICENSE.txt" | ||
}, | ||
{ | ||
"revision": "e2439c581227ea176cdb", | ||
"url": "build/bundle.e2439c58.js" | ||
}, | ||
{ | ||
"revision": "98f1ed5e8becc1b40f5c", | ||
"url": "build/main.98f1ed5e.js" | ||
}, | ||
{ | ||
"revision": "846619c15bc6e252f7b73a147601a1a1", | ||
"url": "details.svg" | ||
}, | ||
{ | ||
"revision": "9611da1b7e819990cfa6229f992af295", | ||
"url": "index.html" | ||
}, | ||
{ | ||
"revision": "8edf28d2ab7313a066202b9d478d1199", | ||
"url": "redux-script-validation.svg" | ||
}, | ||
{ | ||
"revision": "fc40997a7aac2b4d12d9d590246ad09b", | ||
"url": "redux-ws-connection.svg" | ||
}, | ||
{ | ||
"revision": "4ed57b5f5a0c879789dc4d39591f7fcc", | ||
"url": "responsive-grid-state-machine.svg" | ||
}, | ||
{ | ||
"revision": "f48525ee19473056dbb9", | ||
"url": "static/css/2.ee241de9.chunk.css" | ||
}, | ||
{ | ||
"revision": "98f1ed5e8becc1b40f5c", | ||
"url": "static/css/main.f1a0019b.chunk.css" | ||
}, | ||
{ | ||
"revision": "0b78ec9d509f67bfe3f8458c9d285df0", | ||
"url": "static/media/AvenirLTStd-Light.0b78ec9d.otf" | ||
} | ||
]); |
This file was deleted.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
This file was deleted.
This file was deleted.
Large diffs are not rendered by default.
Large diffs are not rendered by default.