Skip to content

Commit 603a963

Browse files
committed
Updated README
1 parent 6c80884 commit 603a963

File tree

1 file changed

+62
-35
lines changed

1 file changed

+62
-35
lines changed

README.md

+62-35
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,63 @@
1-
# Introduction
2-
3-
4-
## Maven Quickstart
5-
```
6-
git clone https://github.com/javaxt-project/javaxt-express-demo.git
7-
cd javaxt-express-demo
8-
mvn install
9-
java -jar dist/express-demo.jar -version
10-
```
11-
12-
Note that during the build, maven will download JavaScript files to support the demos.
13-
JavaScript files are downloaded into the `downloads` folder and then copied into individual
14-
demo folders.
15-
16-
17-
## Demos
18-
19-
### CMS Demo
20-
```
21-
java -jar dist/express-demo.jar -start cms -demo Basic
22-
```
23-
24-
### WebServices Demo
25-
```
26-
java -jar dist/express-demo.jar -start webservices -demo CarSales
27-
```
28-
29-
### React Demo
30-
```
31-
java -jar dist/express-demo.jar -start React -dir /path/to/build
32-
```
33-
34-
35-
## Dev Notes
1+
# Introduction
2+
Command line app and source code used to demonstrate some of the core
3+
capabilities of the javaxt-express library.
4+
5+
## Maven Quickstart
6+
```
7+
git clone https://github.com/javaxt-project/javaxt-express-demo.git
8+
cd javaxt-express-demo
9+
mvn install
10+
java -jar dist/express-demo.jar -version
11+
```
12+
13+
Note that during the build, maven will download JavaScript files to support the demos.
14+
JavaScript files are downloaded into the `downloads` folder and then copied into individual
15+
demo folders.
16+
17+
18+
## Demos
19+
The javaxt-express demos are launched via command line. Each demo will start a
20+
local webserver. By default the server will run on port 9080. You can add an
21+
optional `-p` or `-port` argument to any demo to specify a different port.
22+
23+
### CMS Demo
24+
25+
```
26+
java -jar dist/express-demo.jar -start cms -demo Basic
27+
```
28+
29+
### WebServices Demo
30+
The following command is used to start a REST service used to demonstrate
31+
CRUD operations and persistance.
32+
```
33+
java -jar dist/express-demo.jar -start webservices -demo CarSales
34+
```
35+
36+
### React Demo
37+
The following command is used to host a ReactJS app. This demo supports ReactJS
38+
apps with page routing. Simply provide the path to your ReactJS build.
39+
```
40+
java -jar dist/express-demo.jar -start React -dir /path/to/build
41+
```
42+
43+
### Auth Demos
44+
The following command starts up a simple login demo. You will be prompted to
45+
provide a username and password at start-up. This information will be used to
46+
authenticate a user. You can provide whatever you username/password you want.
47+
Once the server is up and running, it will host a simple login page where you
48+
can test the login.
49+
```
50+
java -jar dist/express-demo.jar -start webapp -demo BasicAuth
51+
```
52+
53+
The following command starts up a login demo that sends a temporary login code
54+
to your email account that you can use to login. You will be prompted to
55+
provide information to your email server including the STMP host, email, and
56+
password. As you can see in the code, this information is not stored anywhere.
57+
```
58+
java -jar dist/express-demo.jar -start webapp -demo EmailLogin
59+
```
60+
61+
62+
## Dev Notes
3663
Update the .gitignore to exclude JavaScript folders copied during the maven build.

0 commit comments

Comments
 (0)