Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nour-karoui/docker-init
a simple react application to get started with docker and DevOps basics
https://github.com/nour-karoui/docker-init
docker docker-compose docker-image dockerfile react travis-ci
Last synced: 19 days ago
JSON representation
a simple react application to get started with docker and DevOps basics
- Host: GitHub
- URL: https://github.com/nour-karoui/docker-init
- Owner: nour-karoui
- License: mit
- Created: 2021-07-22T21:54:42.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-07-29T21:50:10.000Z (over 3 years ago)
- Last Synced: 2024-11-10T19:53:32.691Z (3 months ago)
- Topics: docker, docker-compose, docker-image, dockerfile, react, travis-ci
- Language: HTML
- Homepage:
- Size: 221 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Welcome to Docker Init 👋
#### a simple react application to get started with docker and DevOps basics
### 🏠 [Homepage](https://github.com/nour-karoui/docker-init)
## Install
```sh
> git clone https://github.com/nour-karoui/docker-init.git
> cd frontend
// running the project locally
> npm i
> npm start
```
## How It Works
In this project, we prepared two dockerfiles, to **build two docker images**, one appropriate for **dev env** and the other one for **prod env**
To run this project, make sure you have docker installed and create an account on [Dockerhub](https://hub.docker.com/)
***PS***: You won't need any other dependencies installed, not even nodejs. Since the project on a container.
### 1- Dev Environment
Dockerfile-dev builds an image for developing
##### Running The project
````shell script
docker build -t YOUR_DOCKER_ID/docker-react -f Dockerfile-dev .
docker run -p 3000:3000 YOUR_DOCKER_ID/docker-react
````
##### Running Tests
```shell script
docker run YOUR_DOCKER_ID/docker-react npm run test
```
Since building a docker image means taking a snapshot of the current source code, later changes won't be detected in the docker container.
We configured the docker compose file so that local changes will be automatically propagated to the docker container.
**So instead of**
```shell script
docker run -p 3000:3000 YOUR_DOCKER_ID/docker-react
```
**We simply write**
```shell script
docker-compose up
```
### 2- Prod Environment
Dockerfile builds an image for production
````shell script
docker build -t YOUR_DOCKER_ID/docker-react-prod .
docker run YOUR_DOCKER_ID/docker-react-prod
````
### 3- Github & Travis CI
Each time we push our code to the github repo, Travis CI is triggered to run the build a docker image and run the container to execute the tests and make sure everything works properly.
## Author
👤 **Nour**
* Github: [@nour-karoui](https://github.com/nour-karoui)
* LinkedIn: [@nourkaroui](https://www.linkedin.com/in/nourkaroui/)
## 🤝 Contributing
Contributions, issues and feature requests are welcome!
Feel free to check [issues page](https://github.com/nour-karoui/docker-init/issues). You can also take a look at the [contributing guide](https://github.com/nour-karoui/docker-init/blob/master/CONTRIBUTING.md).
## Show your support
Give a [STAR](https://github.com/nour-karoui/docker-init) if this project helped you!
## 📝 License
* Copyright © 2021 [Nour](https://github.com/nour-karoui).
* This project is [MIT](https://github.com/nour-karoui/docker-init/blob/master/LICENSE) licensed.
***
_This README was generated with by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_