Skip to content

Commit 50b7bbe

Browse files
committedOct 15, 2018
update README.md
1 parent a9fbce4 commit 50b7bbe

File tree

1 file changed

+41
-3
lines changed

1 file changed

+41
-3
lines changed
 

‎README.md

+41-3
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,25 @@
22

33
Open source task management tool built with Vue.js 2, Spring Boot 2, and MySQL 5.7+
44

5-
## Local development
5+
> This is the repository for the book [_Building applications with Spring 5 and Vue.js 2: A real-world practical guide to building a modern full-stack web application_](https://www.amazon.com/Building-applications-Spring-5-0-Vue-js-ebook/dp/B079X1VTST).
66
7-
Create `src/main/resources/application-dev.properties` with the following settings to override the settings in `application.properties`.
7+
## Local development setup
8+
9+
### Prerequisites
10+
11+
- JDK8 - OpenJDK Preferred
12+
- MySQL 5.7+
13+
- RabbitMQ 3.6+
14+
- GraphicMagick 1.3+
15+
16+
### Database setup
17+
18+
- Create database `task_agile`
19+
- Initialize database with scripts in `setup` folder
20+
21+
### Add dev properties file
22+
23+
- Create `src/main/resources/application-dev.properties` with the following settings to override the settings in `application.properties`.
824

925
```properties
1026
spring.datasource.url=jdbc:mysql://localhost:3306/task_agile?useSSL=false
@@ -14,8 +30,30 @@ spring.datasource.password=<your password>
1430

1531
## Commands
1632

17-
- Use `mvn install` to build both the front-end and the back-end
1833
- Use `mvn test` to run the tests of the back-end and the front-end
1934
- Use `mvn spring-boot:run` to start the back-end
2035
- Use `npm run serve` inside the `front-end` directory to start the front-end
36+
- Use `mvn install` to build both the front-end and the back-end
2137
- Use `java -jar target/app-0.0.1-SNAPSHOT.jar` to start the bundled application
38+
39+
## How to run application inside docker
40+
41+
```bash
42+
$ mvn clean package
43+
$ cp target/app-0.0.1-SNAPSHOT.jar docker/app.jar
44+
$ docker build -t taskagile:dev docker/
45+
```
46+
47+
### Start with dev profile locally
48+
49+
```bash
50+
$ docker run --rm --name taskagile -e "SPRING_PROFILES_ACTIVE=dev" -p 8080:8080 -p 9000:9000 taskagile
51+
```
52+
53+
### Start on server
54+
55+
With active profiles `staging` and `docker`. Make sure `docker` is the last one in the list so that the settings in `evn.list` will be applied.
56+
57+
```bash
58+
$ docker run --rm --name taskagile --env-file ./docker/env.list -e "SPRING_PROFILES_ACTIVE=staging,docker" -p 8080:8080 -p 9000:9000 taskagile
59+
```

0 commit comments

Comments
 (0)
Please sign in to comment.