Files

T

Pavel MineevandUmputun c69e375e45 Add "simple view" mode (#502 )

* Add "simple view" mode support

It just hide elements from view when SIMPLE_VIEW recived from server

* Fix typing and add ts check before push

* proper input styling

* Changes for frontend dev compose

* remove SIMPLE_VIEW from default settings for forntend dev
* add private compose to gitignore

* Added simpleView mode for replay and edit modes.

* `simpleView` changed to required param

* FIx border-width in reply form

* Fix border-width in editing mode

2020-01-04 01:31:06 -06:00

app

Add "simple view" mode (#502 )

2020-01-04 01:31:06 -06:00

.babelrc.js

make webpack exclude work

2019-07-29 13:47:35 -05:00

.eslintignore

make webpack exclude work

2019-07-29 13:47:35 -05:00

.eslintrc.js

Update deps 2019 09 (#439 )

2019-09-29 14:09:00 -05:00

.prettierignore

mv web -> frontend

2019-04-28 19:27:36 +03:00

.prettierrc.js

mv web -> frontend

2019-04-28 19:27:36 +03:00

comments.ejs

Define remark host in runtime (#325 )

2019-05-13 10:51:17 -05:00

counter.ejs

Define remark host in runtime (#325 )

2019-05-13 10:51:17 -05:00

deleteme.html

Define remark host in runtime (#325 )

2019-05-13 10:51:17 -05:00

escheck.js

add es5 compatibility check on post build

2019-07-29 13:47:35 -05:00

iframe.html

Define remark host in runtime (#325 )

2019-05-13 10:51:17 -05:00

index.ejs

update demo page to look better on mobile

2019-07-29 13:47:35 -05:00

jest.config.js

update Preact to Preact X

2019-10-28 02:30:49 +03:00

last-comments.ejs

Define remark host in runtime (#325 )

2019-05-13 10:51:17 -05:00

markdown-help.html

Add API methods for setting and deleting email (#483 )

2019-12-16 16:39:55 -06:00

package-lock.json

update deps

2019-10-28 02:46:34 +03:00

package.json

Add "simple view" mode (#502 )

2020-01-04 01:31:06 -06:00

postbuild.js

add es5 compatibility check on post build

2019-07-29 13:47:35 -05:00

privacy.html

mv web -> frontend

2019-04-28 19:27:36 +03:00

Readme.md

docker-compose format and comment fixes (#492 )

2019-12-17 01:36:10 -06:00

remark.image

mv web -> frontend

2019-04-28 19:27:36 +03:00

tsconfig.json

update Preact to Preact X

2019-10-28 02:30:49 +03:00

webpack.config.js

update Preact to Preact X

2019-10-28 02:30:49 +03:00

Readme.md

Frontend guide

Code Style

project uses typescript to statically analyze code
project uses eslint to check frontend code. You can manually run via npm run lint.
git hooks (via husky) installed automatically on npm install and check and try to fix code style if possible, otherwise commit will be rejected
if you want IDE integration, you need eslint plugin to be installed.

CSS Styles

although styles have scss extension, it is actually pack of post-css plugins, so syntax differs, for example in calc function.
component styles use BEM notation (at least it should): block__element_modifier. Also there are mix classes: block_modifier.
component base style resides in the component's root directory with name of component converted to kebab-case. For example ListComments style is located in ./app/components/list-comments/list-comments/scss
component's element style resides in its own subdirectory, with name consisting of full elements selector, for example ListComments item element is placed in __item directory under name ./list-comments__item.scss
each style should be required in index.ts of component's root directory

Imports

imports for typescript, javascript files should be without extension: ./index, not ./index.ts
if file resides in same directory or in subdirectory import should be relative: ./types/something
otherwise it should start from @app namespace: @app/common/store which mapped to /app/common/store.ts in webpack, tsconfig and jest

Testing

project uses jest as test harness.
jest check files that match regex \.test\.(j|t)s(x?)$, i.e comment.test.tsx, comment.test.js
tests are running on push attempt
example tests can be found in ./app/store/user/reducers.test.ts, ./app/components/auth-panel/auth-panel.test.tsx

Notes

Frontend part being bundled on docker env gets placed on /src/web and is available via http://{host}/web. for example embed.js entry point will be available at http://{host}/web/embed.js