Skip to content

Commit d75bf37

Browse files
committed
Update based on PR comments
1 parent 491b41f commit d75bf37

File tree

1 file changed

+17
-9
lines changed

1 file changed

+17
-9
lines changed

README.template.md

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,9 @@
1414
- [End to end tests](#end-to-end-tests)
1515
- [Code quality](#code-quality)
1616
- [Environments](#environments)
17-
- [Environment variables](#environment-variables)
17+
- [Environment variables \[TODO: Remove non-applicable\]](#environment-variables-todo-remove-non-applicable)
18+
- [React](#react)
19+
- [Angular](#angular)
1820
- [List of environment variables](#list-of-environment-variables)
1921
- [Deployment](#deployment)
2022
- [Releases](#releases)
@@ -48,8 +50,10 @@ To build the app you can use some of the following commands:
4850

4951
```
5052
npm run build
51-
npm run build:dev
52-
npm run build:prod # builds the app for production
53+
54+
# TODO: development and production builds if applicable
55+
# npm run build:dev
56+
# npm run build:prod
5357
5458
```
5559

@@ -61,8 +65,8 @@ To start the unit tests you can use one of the following commands:
6165

6266
```
6367
npm run test
64-
npm run test:watch # runs all tests in watch mode and without code coverage report
65-
npm run test:watch:coverage # runs all tests in watch mode with code coverage report
68+
npm run test:watch
69+
npm run test:coverage
6670
6771
```
6872

@@ -76,10 +80,9 @@ The following tools are used in the project to ensure code quality:
7680

7781
Prettier: for consistent code formatting.
7882
ESLint: for identifying and fixing code quality issues.
79-
Stylelint: for identifying and fixing CSS code quality issues.
8083
Husky: Git hooks to automate code quality checks with ESLint and Prettier
8184

82-
Local code quality checks (Prettier, ESLint, and Stylelint) are run before a user can commit their code through Husky's _pre-commit_ hook, which ensures that the code pushed to Git is consistent and doesn't include any obvious issues that can be detected with static analysis.
85+
Local code quality checks (Prettier, ESLint) are run before a user can commit their code through Husky's _pre-commit_ hook, which ensures that the code pushed to Git is consistent and doesn't include any obvious issues that can be detected with static analysis.
8386

8487
## Environments
8588

@@ -92,7 +95,13 @@ There are currently two application environments:
9295
- API: [TODO:PROD_BACKEND_API_URL]
9396
- Frontend: [TODO:PROD_APP_URL]
9497

95-
## Environment variables
98+
## Environment variables [TODO: Remove non-applicable]
99+
100+
### React
101+
102+
You can specify your environment variables in the `.env` file based on `.env.example`.
103+
104+
### Angular
96105

97106
You can specify environment variables as per the guide in the [Nuts & Bolts](https://infinum.github.io/ngx-nuts-and-bolts/docs/environment-variables).
98107

@@ -102,7 +111,6 @@ You can specify environment variables as per the guide in the [Nuts & Bolts](htt
102111
| ---------------- | ----------- | ---------------------------------------------------------- |
103112
| API_HOST | required | API endpoint URL |
104113
| ENV | required | Available options: development, production |
105-
| ASSETS_BASE_HREF | optional | Specifies the base path for the static assets (default: /) |
106114

107115
## Deployment
108116

0 commit comments

Comments
 (0)