cra-template-amplify
Advanced tools
Comparing version
{ | ||
"name": "cra-template-amplify", | ||
"version": "1.0.0", | ||
"version": "1.0.1", | ||
"keywords": [ | ||
@@ -5,0 +5,0 @@ "react", |
@@ -1,68 +0,55 @@ | ||
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). | ||
This is an AWS Amplify Create React App bootstrapped with my preferred setup. | ||
## Available Scripts | ||
This template comes with TypeScript, but TypeScript is not enabled by default. | ||
In the project directory, you can run: | ||
I'm still working through my ESLint ruleset with TypeScript. 🤷🏻♂️ | ||
### `yarn start` | ||
# Setup | ||
Runs the app in the development mode.<br /> | ||
Open [http://localhost:3000](http://localhost:3000) to view it in the browser. | ||
After installing this template with CRA, the first thing you should do in the project folder is run `yarn upd`. This will make sure that all of the libraries are updated to the latest versions. | ||
The page will reload if you make edits.<br /> | ||
You will also see any lint errors in the console. | ||
This template is set up to support Authentication. If you don't need it, you can strip it out. | ||
### `yarn test` | ||
Follow the instructions for how to configure your Amplify project here: | ||
Launches the test runner in the interactive watch mode.<br /> | ||
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information. | ||
https://aws-amplify.github.io/docs/js/react | ||
### `yarn build` | ||
https://aws-amplify.github.io/docs/js/datastore | ||
Builds the app for production to the `build` folder.<br /> | ||
It correctly bundles React in production mode and optimizes the build for the best performance. | ||
The build is minified and the filenames include the hashes.<br /> | ||
Your app is ready to be deployed! | ||
## Available Scripts | ||
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information. | ||
In the project directory, you can run: | ||
### `yarn eject` | ||
### `yarn start` | ||
**Note: this is a one-way operation. Once you `eject`, you can’t go back!** | ||
Runs the app in the development mode.<br> | ||
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. | ||
### `yarn cypress` | ||
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. | ||
Launches the Cypress test runner. | ||
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. | ||
### `yarn amplify-modelgen` | ||
## Learn More | ||
Generates the models for amplify | ||
You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started). | ||
### `yarn amplify-push` | ||
To learn React, check out the [React documentation](https://reactjs.org/). | ||
Pushes to amplify. However, it's probably better to use `amplify push`. | ||
### Code Splitting | ||
### `yarn upd` | ||
This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting | ||
Update all packages to the latest versions and launches the development server. | ||
### Analyzing the Bundle Size | ||
### `yarn test` | ||
This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size | ||
Launches the test runner in the interactive watch mode.<br> | ||
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information. | ||
### Making a Progressive Web App | ||
### `yarn test-cov` | ||
This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app | ||
Launches the test runner and also generates a code coverage report. | ||
### Advanced Configuration | ||
### `yarn test-cov-view` | ||
This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration | ||
### Deployment | ||
This section has moved here: https://facebook.github.io/create-react-app/docs/deployment | ||
### `yarn build` fails to minify | ||
This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify | ||
Requires browser-sync to be install globally. Watches the code coverage folder and automatically refreshes the browser when it changes. |
@@ -9,3 +9,3 @@ { | ||
"cypress": "cypress open", | ||
"upd": "ncu -u -x sass-lint-auto-fix && yarn && yarn start", | ||
"upd": "ncu -u yarn && yarn start", | ||
"test": "react-scripts test --env=jsdom", | ||
@@ -12,0 +12,0 @@ "test-cov": "yarn test --coverage --watch", |
@@ -1,68 +0,55 @@ | ||
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). | ||
This is an AWS Amplify Create React App bootstrapped with my preferred setup. | ||
## Available Scripts | ||
This template comes with TypeScript, but TypeScript is not enabled by default. | ||
In the project directory, you can run: | ||
I'm still working through my ESLint ruleset with TypeScript. 🤷🏻♂️ | ||
### `npm start` | ||
# Setup | ||
Runs the app in the development mode.<br> | ||
Open [http://localhost:3000](http://localhost:3000) to view it in the browser. | ||
After installing this template with CRA, the first thing you should do in the project folder is run `yarn upd`. This will make sure that all of the libraries are updated to the latest versions. | ||
The page will reload if you make edits.<br> | ||
You will also see any lint errors in the console. | ||
This template is set up to support Authentication. If you don't need it, you can strip it out. | ||
### `npm test` | ||
Follow the instructions for how to configure your Amplify project here: | ||
Launches the test runner in the interactive watch mode.<br> | ||
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information. | ||
https://aws-amplify.github.io/docs/js/react | ||
### `npm run build` | ||
https://aws-amplify.github.io/docs/js/datastore | ||
Builds the app for production to the `build` folder.<br> | ||
It correctly bundles React in production mode and optimizes the build for the best performance. | ||
The build is minified and the filenames include the hashes.<br> | ||
Your app is ready to be deployed! | ||
## Available Scripts | ||
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information. | ||
In the project directory, you can run: | ||
### `npm run eject` | ||
### `yarn start` | ||
**Note: this is a one-way operation. Once you `eject`, you can’t go back!** | ||
Runs the app in the development mode.<br> | ||
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. | ||
### `yarn cypress` | ||
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. | ||
Launches the Cypress test runner. | ||
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. | ||
### `yarn amplify-modelgen` | ||
## Learn More | ||
Generates the models for amplify | ||
You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started). | ||
### `yarn amplify-push` | ||
To learn React, check out the [React documentation](https://reactjs.org/). | ||
Pushes to amplify. However, it's probably better to use `amplify push`. | ||
### Code Splitting | ||
### `yarn upd` | ||
This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting | ||
Update all packages to the latest versions and launches the development server. | ||
### Analyzing the Bundle Size | ||
### `yarn test` | ||
This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size | ||
Launches the test runner in the interactive watch mode.<br> | ||
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information. | ||
### Making a Progressive Web App | ||
### `yarn test-cov` | ||
This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app | ||
Launches the test runner and also generates a code coverage report. | ||
### Advanced Configuration | ||
### `yarn test-cov-view` | ||
This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration | ||
### Deployment | ||
This section has moved here: https://facebook.github.io/create-react-app/docs/deployment | ||
### `npm run build` fails to minify | ||
This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify | ||
Requires browser-sync to be install globally. Watches the code coverage folder and automatically refreshes the browser when it changes. |
59539
-4.17%56
-18.84%