Skip to content

Commit a22e66f

Browse files
committed
Update README.md and remove unnecessary texts.
1 parent 82e99e5 commit a22e66f

File tree

1 file changed

+4
-45
lines changed

1 file changed

+4
-45
lines changed

README.md

Lines changed: 4 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,9 @@
11
[![MIT License][license-badge]][LICENSE]
22

3-
# :copyright: java-play-angular-seed
3+
# java-play-angular-seed
44

55
> java-play-angular-seed project illustrates how Play Framework can be used to develop backend/services along with Angular to develop the front-end/ui.
66
7-
> This is a totally integrated Java Play 2.6.x + Angular 5 with Angular CLI seed project with full-fledged build process.
8-
97
## Used Versions
108

119
* [Play Framework: 2.6.7](https://www.playframework.com/documentation/2.6.x/Home)
@@ -113,14 +111,6 @@
113111
├── /ui/
114112
│ ├── proxy.conf.json
115113
```
116-
117-
## Controllers
118-
119-
There are several demonstration files available in this template.
120-
121-
- HomeController.java:
122-
123-
Shows how to handle simple HTTP requests.
124114

125115
## Routes
126116

@@ -129,44 +119,13 @@ There are several demonstration files available in this template.
129119
│ ├── routes
130120
```
131121

132-
* All the route definitions should be included in this file based on higher priority first. In this example project following route is added to retrieve the summary.
122+
* The following route configuration allows to map front end index.html to index route. This should be placed as the first route in this file.
133123

134124
```
135-
GET /summary controllers.HomeController.appSummary()
125+
GET / controllers.Assets.at(path="/public/ui", file="index.html")
136126
```
137127

138-
* The below service is there in the front-end to manage the http requests which defined in the backend service.
139-
140-
```
141-
├── /ui/
142-
│ ├── /src/
143-
│ │ ├── /app/
144-
│ │ │ ├── app.service.ts
145-
```
146-
147-
```javascript
148-
@Injectable()
149-
export class AppService {
150-
private serviceUrl = '/summary';
151-
152-
constructor(private http: HttpClient) {
153-
}
154-
155-
/**
156-
* Makes a http get request to retrieve the welcome message from the backend service.
157-
*/
158-
public getWelcomeMessage() {
159-
return this.http.get(this.serviceUrl)
160-
.map(response => response)
161-
}
162-
}
163-
```
164-
165-
## Components
166-
167-
- Module.java:
168-
169-
Bind all the components needed by your application.
128+
**Note: _On production build all the front end Angular build artifacts will be copied to the `public/ui` folder._**
170129

171130
## Contributors
172131

0 commit comments

Comments
 (0)