mikeconrad/react-docker-env
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add basic documentation

Browse Source
This commit is contained in:
Mike Conrad
2024-10-16 17:48:49 -04:00
parent 17e672e695
commit 2a0df635fb
1 changed files with 12 additions and 66 deletions
Download Patch File Download Diff File Expand all files Collapse all files

78
README.md
View File

@ -1,70 +1,16 @@
# Getting Started with Create React App
## Overview
This is a simple demo meant to demonstrate the process of using environment variables with Docker/React. When we build the image we pass the value of the environment variables as build arguments. You can specify as many as you need. In this example I am only using one but you can have multiple like this as well:
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
```shell
docker build --build-arg ARG1=test --build-arg ARG2=test .
```
## Available Scripts
In the project directory, you can run:
## Build and run
To build and run this example you can use the below commands.
```shell
docker build -t react-docker-test --build-arg MY_VARIABLE=world .
docker run -p 3000:3000 react-docker-test
```
### `npm start`
Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in your browser.
The page will reload when you make changes.\
You may also see any lint errors in the console.
### `npm test`
Launches the test runner in the interactive watch mode.\
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
### `npm run build`
Builds the app for production to the `build` folder.\
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.\
Your app is ready to be deployed!
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
### `npm run eject`
**Note: this is a one-way operation. Once you `eject`, you can't go back!**
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.
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.
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.
## Learn More
You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
To learn React, check out the [React documentation](https://reactjs.org/).
### Code Splitting
This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)
### Analyzing the Bundle Size
This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)
### Making a Progressive Web App
This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)
### Advanced Configuration
This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](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](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](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)
If everything goes well, once the application has fully started you should be able to navigate to `http://localhost:3000` in your browser and see the text "Hello world" on the screen.