Skip to content

Commit 2f253ac

Browse files
author
borysn
committed
update readme
1 parent be21ed5 commit 2f253ac

File tree

1 file changed

+19
-28
lines changed

1 file changed

+19
-28
lines changed

README.md

Lines changed: 19 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,16 @@
1-
[![Build Status](https://travis-ci.org/borysn/spring-boot-angular2.svg?branch=master)](https://travis-ci.org/borysn/spring-boot-angular2)
2-
[![Gitter](https://badges.gitter.im/borysn/spring-boot-angular2.svg)](https://gitter.im/borysn/spring-boot-angular2?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
3-
[![bitHound Dependencies](https://www.bithound.io/github/borysn/spring-boot-angular2/badges/dependencies.svg)](https://www.bithound.io/github/borysn/spring-boot-angular2/master/dependencies/npm)
4-
[![bitHound Dev Dependencies](https://www.bithound.io/github/borysn/spring-boot-angular2/badges/devDependencies.svg)](https://www.bithound.io/github/borysn/spring-boot-angular2/master/dependencies/npm)
1+
[![build status](https://travis-ci.org/borysn/spring-boot-angular2.svg?branch=master)](https://travis-ci.org/borysn/spring-boot-angular2)
2+
[![gitter](https://badges.gitter.im/borysn/spring-boot-angular2.svg)](https://gitter.im/borysn/spring-boot-angular2?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
3+
[![bithound dependencies](https://www.bithound.io/github/borysn/spring-boot-angular2/badges/dependencies.svg)](https://www.bithound.io/github/borysn/spring-boot-angular2/master/dependencies/npm)
4+
[![bithound dev dependencies](https://www.bithound.io/github/borysn/spring-boot-angular2/badges/devdependencies.svg)](https://www.bithound.io/github/borysn/spring-boot-angular2/master/dependencies/npm)
55

6-
# upcoming changes
6+
## [change log](https://github.com/borysn/spring-boot-angular2/blob/master/CHANGELOG.md)
77

8-
* [sba2-wip repo](https://gitlab.com/borysn/sba2-wip)
9-
10-
Changes coming later today! Large commit (no regrets).
11-
12-
Migration to webpack is complete.
13-
14-
Karma testing with jasmine.
15-
16-
Firstclass npm support, and more!
17-
18-
__todo:__
8+
## todo
199
- [x] create new branch for old code (just'n'case anyone wants it)
2010
- [x] publish first release with old code
2111
- [x] push new changes!
22-
- [ ] create changelog
23-
- [ ] update readme
12+
- [x] create changelog
13+
- [x] update readme
2414
- [ ] wiki updates
2515
- [ ] add project structure page
2616
- [ ] update dependencies page
@@ -30,7 +20,7 @@ __todo:__
3020

3121
# spring-boot-angular2 starter kit
3222

33-
Spring Boot with Angular2, Bootstrap4, TypeScript, Sass, Gradle, and Gulp.
23+
spring boot backend, angular2 frontend with webpack, typescript, sass, bootstrap4, karma, jasmine
3424

3525
## about
3626

@@ -40,38 +30,39 @@ anuglar2 with es6 support. unit tests with jasmine.
4030

4131
## pre-install
4232

43-
1. install OpenJDK8
33+
1. install jdk8
4434
- set `JAVA_HOME` environment variable
4535
1. (optional) install latest gradle
4636
- otherwise just use `$ ./gradlew`
4737
1. (optional) install python 2.7.x
48-
- set `PYTHON` environment variable
49-
- `$ gradle npminstall` may complain otherwise
38+
- set `python` environment variable
39+
- `$ gradle npmInstall` may complain otherwise
5040

5141
## install
5242

5343
`$ git clone [email protected]:borysn/spring-boot-angular2`
5444

5545
## build & run
5646

57-
* `$ gradle clean build`
58-
* `$ gradle bootRun`
59-
* using browser, navigate to`localhost:8080`
47+
* `$ gradle clean build runAll`
48+
- server side will finish building first
49+
- give npm/webpack a little time to finish up
50+
* using browser, navigate to`localhost:3000`
6051

6152
## further reading
6253

6354
[wiki](https://github.com/borysn/spring-boot-angular2/wiki)
6455

6556
## example
6657

67-
check out my [RVEP](https://gitlab.com/borysn/RVEP/tree/dev) project. it's built and updated according to this starter kit!
58+
check out my [rvep](https://gitlab.com/borysn/rvep/tree/dev) project. it's built and updated according to this starter kit!
6859

6960
## contribute
7061

7162
if you have any input, or contributions, please share!
7263

7364
## donations
74-
[donate](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=4NPQ49B5NRV3E&lc=US&item_name=Borys%20Niewiadomski&currency_code=USD&bn=PP%2dDonationsBF%3abtn_donate_LG%2egif%3aNonHosted) a cup of coffe
65+
[donate](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=4npq49b5nrv3e&lc=us&item_name=borys%20niewiadomski&currency_code=usd&bn=pp%2ddonationsbf%3abtn_donate_lg%2egif%3anonhosted) a cup of coffe
7566

7667
## license
77-
[MIT](/LICENSE)
68+
[mit](/license)

0 commit comments

Comments
 (0)