Added how-to for docker deployment to the readme
This commit is contained in:
parent
5d00f7db10
commit
e4d916b07c
40
README.md
40
README.md
|
@ -2,26 +2,54 @@
|
|||
|
||||
This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 9.1.7.
|
||||
|
||||
## Development server
|
||||
## Angular CLI
|
||||
### Development server
|
||||
|
||||
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.
|
||||
|
||||
## Code scaffolding
|
||||
### Code scaffolding
|
||||
|
||||
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`.
|
||||
|
||||
## Build
|
||||
### Build
|
||||
|
||||
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.
|
||||
|
||||
## Running unit tests
|
||||
### Running unit tests
|
||||
|
||||
Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).
|
||||
|
||||
## Running end-to-end tests
|
||||
### Running end-to-end tests
|
||||
|
||||
Run `ng e2e` to execute the end-to-end tests via [Protractor](http://www.protractortest.org/).
|
||||
|
||||
## Further help
|
||||
### Further help
|
||||
|
||||
To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI README](https://github.com/angular/angular-cli/blob/master/README.md).
|
||||
|
||||
## Deploy with Docker
|
||||
> Prerequisite: Docker and/or Docker Compose have to be installed on your system </br>
|
||||
> The Docker installation instructions for most operation systems can be found here: [https://docs.docker.com/get-docker/](https://docs.docker.com/get-docker/) </br>
|
||||
> The Docker Compose installation instructions for most operation systems can be found here: [https://docs.docker.com/compose/install/](https://docs.docker.com/compose/install/)
|
||||
|
||||
### Quick Deployment with Docker Compose
|
||||
1. Clone the git repo
|
||||
2. Open the cloned repo's folder in a shell of your choice (as long as it supports Docker)
|
||||
3. Tell Docker Compose to build - if it hasn't already been built - and run the app with `docker-compose up`
|
||||
|
||||
Other useful commands:
|
||||
* Just build: `docker-compose build`
|
||||
* Build before running: `docker-compose up --build`
|
||||
* Run attached (in the background): `docker-compose up -d`
|
||||
* Stop: `docker-compose down`
|
||||
* Restart: `docker-compose restart`
|
||||
|
||||
### Build the Container yourself (and run it)
|
||||
1. Clone the git repo
|
||||
2. Open the cloned repo's folder in a shell of your choice (as long as it supports Docker)
|
||||
3. Tell Docker to build the app under the name "frontend" with `docker build -t taskboard_frontend .`
|
||||
4. Tell Docker to run the app on port 8080 with `docker run -p 8080:80 taskboard_frontend`
|
||||
|
||||
Other useful commands:
|
||||
* Run detached: `docker run -d -p 8080:80 taskboard_frontend`
|
||||
* Run under specified name: `docker run -p 8080:80 --name frontend taskboard_frontend`
|
Loading…
Reference in New Issue
Block a user