Skip to content

Commit a74ea4b

Browse files
committed
chore: update readme
1 parent 7453dbd commit a74ea4b

File tree

1 file changed

+18
-14
lines changed

1 file changed

+18
-14
lines changed

README.md

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,31 @@
1-
# App
1+
# Shop Angular Cloudfront
22

3-
This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 11.2.10.
3+
Angular version: ~12.
44

5-
## Development server
5+
Repo maintainers:
66

7-
Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
7+
- [Sergey Gultyayev](https://github.com/gultyaev)
88

9-
## Code scaffolding
9+
## The purpose
1010

11-
Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`.
11+
The repository was created to have an Angular version of e-shop for RS School's NodeJS AWS course. At the same time we strive to make this repository follow best practices so it may be used as a starter for new projects with all the necessary toolings already set up.
1212

13-
## Build
13+
## NodeJS AWS course integration
1414

15-
Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `--prod` flag for a production build.
15+
All the necessary API endpoints are in the environments files `environment.ts` (for dev builds). Also it contains feature flags to enable/disable endpoints invocations from within the app so to ensure that you don't get errors for not implemented API endpoints.
1616

17-
## Running unit tests
17+
## Contribution
1818

19-
Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).
19+
Create an issue with the detailed description of the improvement/issue.
2020

21-
## Running end-to-end tests
21+
If you would like to help implementing some feature, you should ask the maintainers for approval so to ensure that the feature is desired in the repository and no efforts go wasted.
2222

23-
Run `ng e2e` to execute the end-to-end tests via [Protractor](http://www.protractortest.org/).
23+
## Get up and running
2424

25-
## Further help
25+
Prerequisites: NodeJS v14
2626

27-
To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.io/cli) page.
27+
Follow the steps:
28+
29+
- git clone
30+
- npm i
31+
- ng serve

0 commit comments

Comments
 (0)