Files

T

Pavel MineevandUmputun 7ce400a5e5 move getting of hidden users to utils

* get hidden user by util
* add tests for changed actions
* add tests for getting users from local storage

2020-03-25 01:52:46 -05:00

app

move getting of hidden users to utils

2020-03-25 01:52:46 -05:00

tasks

Added Finnish translation

2020-03-18 11:15:30 -05:00

.babelrc.js

optimize bundle sizes

2020-02-22 00:48:22 -06:00

.eslintignore

Cleanup embed.ts and add limit-size checker (#601 )

2020-02-19 16:08:35 -06:00

.eslintrc.js

Nice inputs and buttons (#510 )

2020-01-05 14:58:10 -06:00

.gitignore

Add localization (#602 )

2020-03-04 14:56:00 -06:00

.lintstagedrc.js

Introduce stylelint (#600 )

2020-02-16 11:25:59 -06:00

.prettierignore

mv web -> frontend

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

.prettierrc

Run prettier on all files

2020-01-05 17:52:25 -06:00

.size-limit.js

Reduce size of last-comments widget

2020-03-07 03:59:03 -06:00

.stylelintignore

Introduce stylelint (#600 )

2020-02-16 11:25:59 -06:00

.stylelintrc.js

#5 use css custom properties instead of color constant

2020-03-05 12:34:40 +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

Refactor preloader

2020-01-07 11:14:59 -06:00

iframe.html

#5 implement POC for theming api

2020-03-05 12:35:15 +03:00

index.ejs

#5 implement POC for theming api

2020-03-05 12:35:15 +03:00

jest.config.js

Fix saving of comment sorting

2020-03-22 16:11:01 -05:00

last-comments.ejs

Run prettier on all files

2020-01-05 17:52:25 -06:00

markdown-help.html

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

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

package-lock.json

Fix saving of comment sorting

2020-03-22 16:11:01 -05:00

package.json

Fix saving of comment sorting

2020-03-22 16:11:01 -05:00

privacy.html

Small refactoring (#609 )

2020-03-07 12:25:18 -06:00

Readme.md

Add localization (#602 )

2020-03-04 14:56:00 -06:00

remark.image

mv web -> frontend

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

tsconfig.json

Add localization (#602 )

2020-03-04 14:56:00 -06:00

webpack.config.js

#5 use css custom properties instead of color constant

2020-03-05 12:34:40 +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

how to add new locale.

add new item to ./tasks/supportedLocales.json
run npm run generate-langs
commit all changed files
translate all string in new generated dictionary ./app/locale/<new-locale>.json

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