Skip to content

Commit ae777a2

Browse files
committed
Update README.md
1 parent 939e42f commit ae777a2

File tree

4 files changed

+245
-25
lines changed

4 files changed

+245
-25
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ lerna-debug.log*
99

1010
node_modules
1111
.serverless
12+
coverage
1213
dist
1314
dist-ssr
1415
*.local

README.md

Lines changed: 51 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,71 @@
1-
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
1+
# React-shop-cloudfront
2+
3+
This is frontend starter project for nodejs-aws mentoring program. It uses the following technologies:
4+
5+
- [Vite](https://vitejs.dev/) as a project bundler
6+
- [React](https://beta.reactjs.org/) as a frontend framework
7+
- [React-router-dom](https://reactrouterdotcom.fly.dev/) as a routing library
8+
- [MUI](https://mui.com/) as a UI framework
9+
- [React-query](https://react-query-v3.tanstack.com/) as a data fetching library
10+
- [Formik](https://formik.org/) as a form library
11+
- [Yup](https://github.com/jquense/yup) as a validation schema
12+
- [Serverless](https://serverless.com/) as a serverless framework
13+
- [Vitest](https://vitest.dev/) as a test runner
14+
- [MSW](https://mswjs.io/) as an API mocking library
15+
- [Eslint](https://eslint.org/) as a code linting tool
16+
- [Prettier](https://prettier.io/) as a code formatting tool
17+
- [TypeScript](https://www.typescriptlang.org/) as a type checking tool
218

319
## Available Scripts
420

5-
In the project directory, you can run:
6-
You can use NPM instead of YARN (Up to you)
21+
### `start`
722

8-
### `yarn start` OR `npm run start`
23+
Starts the project in dev mode with mocked API on local environment.
924

10-
Runs the app in the development mode.<br />
11-
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
25+
### `build`
1226

13-
The page will reload if you make edits.<br />
14-
You will also see any lint errors in the console.
27+
Builds the project for production in `dist` folder.
1528

16-
### `yarn test` OR `npm run test`
29+
### `preview`
1730

18-
Launches the test runner in the interactive watch mode.<br />
19-
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
31+
Starts the project in production mode on local environment.
2032

21-
### `yarn build` OR `npm run build`
33+
### `test`, `test:ui`, `test:coverage`
2234

23-
Builds the app for production to the `build` folder.<br />
24-
It correctly bundles React in production mode and optimizes the build for the best performance.
35+
Runs tests in console, in browser or with coverage.
2536

26-
The build is minified and the filenames include the hashes.<br />
27-
Your app is ready to be deployed!
37+
### `lint`, `prettier`
2838

29-
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
39+
Runs linting and formatting for all files in `src` folder.
3040

31-
### `yarn eject` OR `npm run eject`
41+
### `client:deploy`, `client:deploy:nc`
3242

33-
**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
43+
Deploy the project build from `dist` folder to configured in `serverless.yml` AWS S3 bucket with or without confirmation.
3444

35-
If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
45+
### `client:build:deploy`, `client:build:deploy:nc`
3646

37-
Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
47+
Combination of `build` and `client:deploy` commands with or without confirmation.
3848

39-
You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
49+
### `cloudfront:setup`
4050

41-
## Learn More
51+
Deploy configured in `serverless.yml` stack via CloudFormation.
4252

43-
You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
53+
### `cloudfront:domainInfo`
4454

45-
To learn React, check out the [React documentation](https://reactjs.org/).
55+
Display cloudfront domain information in console.
56+
57+
### `cloudfront:invalidateCache`
58+
59+
Invalidate cloudfront cache.
60+
61+
### `cloudfront:build:deploy`, `cloudfront:build:deploy:nc`
62+
63+
Combination of `client:build:deploy` and `cloudfront:invalidateCache` commands with or without confirmation.
64+
65+
### `cloudfront:update:build:deploy`, `cloudfront:update:build:deploy:nc`
66+
67+
Combination of `cloudfront:setup` and `cloudfront:build:deploy` commands with or without confirmation.
68+
69+
### `serverless:remove`
70+
71+
Remove an entire stack configured in `serverless.yml` via CloudFormation.

package-lock.json

Lines changed: 192 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)