Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/master'
Browse files Browse the repository at this point in the history
  • Loading branch information
alex-gru committed Apr 5, 2017
2 parents c047d31 + 3e0be85 commit 2aa8a6d
Showing 1 changed file with 13 additions and 14 deletions.
27 changes: 13 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Project repository for the course `Selected Topics in Software Engineering`, Dep
## Project Plan
Course perspective and all relevant information can be [found here.](https://docs.google.com/document/d/1RymleWm07xmH_LnFB5_LOq7yFwj1wB7OvTax7AeAAUc/edit?usp=sharing)

## Build & Run
## Non-Development: Build & Run

1. Download and install `Docker` on your machine: [Docker Store](https://store.docker.com/search?type=edition&offering=community)

Expand All @@ -22,34 +22,33 @@ Course perspective and all relevant information can be [found here.](https://doc

5. Run the application

**Development only**:
`docker run --name course-planner -p 8080:8080 course-planner`

First, install dependencies locally.
`-d` makes the container running in the background (use `docker stop course-planner` to stop)

`npm install`
`-p 8080:8080` maps the app-internal port 8080 to the external port 8080

Now, we run `docker-compose` ([docker-compose.yml]()) which runs `nodemon` to enable debugging and auto restart on file changes (both front- and backend).
optional: `-d` makes the container running in the background (use `docker stop course-planner` to stop)

`docker-compose up --build`

`-build` rebuilds the image if changes are detected
## Development only: Build & Run & Debug & Hot-Code-Reload

This builds and creates the container, and attaches the debugger and file watcher (hot code reload), more details: [see here](https://docs.docker.com/compose/reference/up/)
First, install dependencies locally.

optional: `-d` makes the container running in the background (use `docker stop course-planner` to stop)
`npm install`

**Non-development environments**:
Now, we run `docker-compose` ([docker-compose.yml](docker-compose.yml)) which runs `nodemon` to enable debugging and auto restart on file changes (both front- and backend).

`docker run --name course-planner -p 8080:8080 course-planner`
`docker-compose up --build`

`-d` makes the container running in the background (use `docker stop course-planner` to stop)
`-build` rebuilds the image if changes are detected

`-p 8080:8080` maps the app-internal port 8080 to the external port 8080
This builds and (re-)creates the container, and attaches the debugger and file watcher (auto-restart with `nodemon`).

optional: `-d` makes the container running in the background (use `docker stop course-planner` to stop)


6. Display the app in your browser
## Display the app in your browser

[http://localhost:8080](http://localhost:8080)

0 comments on commit 2aa8a6d

Please sign in to comment.