You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+22-22Lines changed: 22 additions & 22 deletions
Original file line number
Diff line number
Diff line change
@@ -45,7 +45,7 @@ PRs should also have a description that includes a link to the Jira ticket and a
45
45
46
46
All branches use `dev` as their source. All merges to `dev` should be made via [pull request](#pull-requests) and should be approved by application owner(s).
47
47
48
-
When working on Jira tickets, a branch should correspond with a single ticket.
48
+
When working on Jira tickets, a branch should correspond with a single ticket.
49
49
50
50
When using subtasks, each parent ticket should have its own branch off `dev`, and all subtasks branches should be merged into the parent ticket branch instead of directly to `dev`.
51
51
@@ -93,12 +93,12 @@ Use the [VS Code](https://code.visualstudio.com/download) IDE for MFE developmen
93
93
### nvm
94
94
Use the node version manager [nvm](https://github.com/nvm-sh/nvm/blob/master/README.md) to easily and safely manage the required version of NodeJS (aka, node). Download and install it per the instructions for your development operating system. Installing a version of node via `nvm` will also install `npm`.
95
95
96
-
Once nvm is installed, run:
96
+
Once nvm is installed, run:
97
97
98
98
>% nvm install <insertnodeversion>
99
99
100
100
101
-
At the root of the project directory you'll notice a file called `.nvmrc` which specifies the node version used by the project. The command `nvm use` will use the version specified in the file if no version is supplied on the command line.
101
+
At the root of the project directory you'll notice a file called `.nvmrc` which specifies the node version used by the project. The command `nvm use` will use the version specified in the file if no version is supplied on the command line.
102
102
See [the nvm Github README](https://github.com/nvm-sh/nvm/blob/master/README.md#nvmrc) for more information on setting this up.
103
103
104
104
>**NOTE:** The current node version mentioned in the `.nvmrc` is `16.15.0`
@@ -120,7 +120,7 @@ export NVM_DIR=~/.nvm
120
120
121
121
If you don't have this set globally, you can create your own [personal config](#personal-config) to define your local nvm dir.
122
122
123
-
### Hosting
123
+
### Hosting
124
124
You will need to add the following line to your hosts file. The hosts file is normally located at `/etc/hosts` (Mac). Do not overwrite the existing localhost entry also pointing to 127.0.0.1.
125
125
126
126
```
@@ -145,13 +145,13 @@ You will need to add the following line to your hosts file. The hosts file is no
145
145
146
146
### Local SSL
147
147
148
-
SSL is required for authentication to work properly.
148
+
SSL is required for authentication to work properly.
149
149
150
-
The `yarn start` command serves the site using the cert and key in the /ssl directory, which authorize the `https://local.topcoder-dev.com`URL.
150
+
The `yarn start` command serves the site using the cert and key in the /ssl directory, which authorize the `https://local.topcoder-dev.com`URL.
151
151
152
152
By overriding the app to use <b>port 443</b>, you can use the authorized URL and trust the root CA to avoid SSL errors in the browser.
153
153
154
-
>**NOTE:** Mac users will require running the app with elevated permissions in order to use a port lower than 500.
154
+
>**NOTE:** Mac users will require running the app with elevated permissions in order to use a port lower than 500.
155
155
156
156
For easier development, it is recommended that you add this certificate to your trusted root authorities and as a trused cert in your browser. Google your browser and OS for more info on how to trust cert authorities.
157
157
@@ -168,7 +168,7 @@ Otherwise, you will need to override the exception each time you load the site.
168
168
7. Prior to starting the server, set your host name:
169
169
```% export REACT_APP_HOST_ENV=[hostname]```
170
170
171
-
>**NOTE:** Individual tools (e.g. [Learn tool](/src-ts/tools/learn/README.md)) can have their own configuration, which can be configured the same way as the global config.
171
+
>**NOTE:** Individual tools (e.g. [Learn tool](/src-ts/tools/learn/README.md)) can have their own configuration, which can be configured the same way as the global config.
172
172
173
173
#### For further convenience
174
174
@@ -196,7 +196,7 @@ Each [Tool](#tools) can have its own setup requirements. Please see each tool's
196
196
|`yarn lint:js:fix`| Run eslint against js/x files, fixes auto-fixable issues, and outputs report |
197
197
|`yarn lint`| Run eslint against js/x and ts/x files and outputs report |
198
198
|`yarn lint:fix`| Run eslint against js/x and ts/x files, fixes auto-fixable issues, and outputs report |
199
-
|`yarn test`| Run unit tests, watching for changes and re-running per your specifications |
199
+
|`yarn test`| Run unit tests, watching for changes and re-running per your specifications |
200
200
|`yarn test:no-watch`| Run unit tests once, without watching for changes or re-running |
201
201
|`yarn cy:run`| Run e2e tests once in local command with the site is running |
202
202
|`yarn cy:ci`| Run e2e tests once by circle ci |
@@ -271,8 +271,8 @@ The Tool Selectors on the site [Header](#src-tsheader) correlate 1:1 to director
271
271
The name of a tool's directory should correlate w/the name of the tool and its url.
272
272
273
273
```
274
-
i.e. /src-ts/tools/[tool-name] == platform.topcoder.com/[tool-name]
275
-
e.g. /src-ts/tools/work == platform.topcoder.com/work
274
+
i.e. /src-ts/tools/[tool-name] == platform-ui.topcoder.com/[tool-name]
275
+
e.g. /src-ts/tools/work == platform-ui.topcoder.com/work
276
276
```
277
277
278
278
>**NOTE:** Tools should not import modules from any directories other than lib. If it is necessary to import from outside the lib, the shared code should generally be moved to lib.
@@ -286,8 +286,8 @@ The Utility Selectors in the site [Header](#src-tsheader) correlate 1:1 to direc
286
286
The name of a util's directory should correlate w/the name of the util and its url.
287
287
288
288
```
289
-
i.e. /src-ts/utils/[util-name] == platform.topcoder.com/[util-name]
290
-
e.g. /src-ts/utils/profile == platform.topcoder.com/profile
289
+
i.e. /src-ts/utils/[util-name] == platform-ui.topcoder.com/[util-name]
290
+
e.g. /src-ts/utils/profile == platform-ui.topcoder.com/profile
291
291
```
292
292
293
293
>**NOTE:** Utils should not import modules from any directories other than lib. If it is necessary to import from outside the lib, the shared code should generally be moved to lib.
@@ -398,7 +398,7 @@ VS Code has several plugins and settings that make linting easy.
398
398
399
399
The most useful feature is to automatically apply all lint rules any time you save a file.
400
400
401
-
1) Code → Preferences → Settings
401
+
1) Code → Preferences → Settings
402
402
403
403
2) Search for “save” to find the setting
404
404
- Editor: Code Actions on Save
@@ -470,11 +470,11 @@ Colors and Gradients are defined as variables in `src-ts/lib/styles/_palette.scs
470
470
471
471
### Padding
472
472
473
-
Padding for various screen sizes are defined as variables in `src-ts/lib/styles/_layout.scss`. This file also contains a mixin called `pagePaddings` that determines the correct padding to use for the current screen size based on breakpoints.
473
+
Padding for various screen sizes are defined as variables in `src-ts/lib/styles/_layout.scss`. This file also contains a mixin called `pagePaddings` that determines the correct padding to use for the current screen size based on breakpoints.
474
474
475
475
### Breakpoints
476
476
477
-
Breakpoint mixins are defined in `src-ts/lib/styles/_breakpoints.scss` and can be used to apply different styling based on the screen width.
477
+
Breakpoint mixins are defined in `src-ts/lib/styles/_breakpoints.scss` and can be used to apply different styling based on the screen width.
478
478
479
479
Here is an example that applies a different height value than the default to a css class selector if the screen is considered small (376px - 464px).
480
480
@@ -502,7 +502,7 @@ example.scss
502
502
}
503
503
```
504
504
505
-
Mobile UIs use xs, sm, and md breakpoints. Larger breakpoints are desktop UIs.
505
+
Mobile UIs use xs, sm, and md breakpoints. Larger breakpoints are desktop UIs.
506
506
507
507
For specifying mobile CSS, you can use @include ltemd:
508
508
```
@@ -525,7 +525,7 @@ For specifying mobile CSS, you can use @include ltemd:
525
525
### Heroicons
526
526
We use the SVG icons library [Heroicons](https://heroicons.com/), where each icon is available in an `outline` or `solid` version.
527
527
528
-
We import both sets of icons in the file `src-ts/lib/svgs/index.ts`.
528
+
We import both sets of icons in the file `src-ts/lib/svgs/index.ts`.
529
529
```
530
530
import * as IconOutline from '@heroicons/react/outline'
531
531
import * as IconSolid from '@heroicons/react/solid'
@@ -554,8 +554,8 @@ See the /src-ts/lib/svgs for an example.
554
554
555
555
### Styling Icons
556
556
557
-
You can style an SVG icon by overwritting its properties through CSS (height, width, fill, etc.).
558
-
There are also existing mixins located in `src-ts/lib/styles/_icons.scss` with pre-defined widths and heights for various icon sizes.
557
+
You can style an SVG icon by overwritting its properties through CSS (height, width, fill, etc.).
558
+
There are also existing mixins located in `src-ts/lib/styles/_icons.scss` with pre-defined widths and heights for various icon sizes.
559
559
560
560
e.g.:
561
561
```
@@ -568,7 +568,7 @@ e.g.:
568
568
path {
569
569
fill: $tc-white;
570
570
}
571
-
}
571
+
}
572
572
}
573
573
574
574
.no-logo-link {
@@ -589,7 +589,7 @@ e.g.:
589
589
590
590
# Tools
591
591
592
-
The following summarizes the various [tools](#adding-a-tool-or-util) in the Platform UI.
592
+
The following summarizes the various [tools](#adding-a-tool-or-util) in the Platform UI.
0 commit comments