Skip to content
This repository was archived by the owner on May 30, 2019. It is now read-only.

Commit 3d8ff2c

Browse files
author
Charles Greer
committed
README edits
1 parent c17de36 commit 3d8ff2c

File tree

2 files changed

+12
-7
lines changed

2 files changed

+12
-7
lines changed

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ The setup instructions assume you have the `git`, `javac`, `node`, `bower`, and
3131
The setup procedure may install additional software, such as Gradle and Angular.
3232

3333
## Getting Started
34-
Follow this procedure to set up samplestack in your environment.
34+
Follow this procedure to set up Samplestack in your environment.
3535

3636
1. Install MarkLogic 8 Early Access. See http://ea.marklogic.com/download.
3737

@@ -50,7 +50,7 @@ Follow this procedure to set up samplestack in your environment.
5050
### Setting Up the Middle and Database Tiers
5151
The setup assume you have MarkLogic Server running on your localhost and that your Admin user credentials are admin:admin. To change this, modify `appserver/java-spring/gradle.properties`.
5252
53-
To install required software, configure, and build the Java middle tier and database tier of samplestack, run the following commands from the root of your cloned repository:
53+
To install required software, configure, and build the Java middle tier and database tier of Samplestack, run the following commands from the root of your cloned repository:
5454
5555
```bash
5656
cd appserver/java-spring
@@ -63,7 +63,7 @@ If the command fails such that you need to run it again, run the following comma
6363
./gradlew dbteardown
6464
```
6565

66-
This command will not return. When you see output of the following form, the mi ddle tier is running, and you can proceed with the browser tier setup:
66+
This command will not return. When you see output of the following form, the middle tier is running, and you can proceed with the browser tier setup:
6767
```
6868
Started Application in X seconds...
6969
>Building 85% > :bootRun
@@ -80,7 +80,7 @@ The middle tier App Server runs on port 8090 by default. Visit http://localhost:
8080
*For details, see the [README in the appserver/java-spring directory](appserver/java-spring/README.md)*
8181

8282
### Setting Up the Browser Tier
83-
Use the following procedure To install required software and bootstrap the samplestack browser tier. You should already have the middle and database tiers running.
83+
Use the following procedure to install required software and bootstrap the Samplestack browser tier. You should already have the middle and database tiers running.
8484

8585
For detailed instructions and troubleshooting, see the [README in the browser directory](browser/README.md).
8686

@@ -120,15 +120,16 @@ gulp run
120120

121121
### Next Steps
122122
* Explore the application running at http://localhost:3000.
123+
** Use the login credentials [email protected], password joesPassword to view and search content restricted to the Contributor role.
123124
* Explore the README in the database, appserver and browser directories for details on each tier.
124125
* View the database configuration by visiting http://localhost:8001.
125-
* Explore the database contents using Query Console. Go to http://localhost:8000/qconsole, select the samplestack database, and click Explore.
126+
* Explore the database contents using Query Console. Go to http://localhost:8000/qconsole, select the `samplestack` database, and click Explore.
126127

127128
## Additional Information
128129
For more information, see the following:
129130
* README for the [database](database/README.md), [appserver](appserver/java-spring/README.md), and [browser](browser/README.md) tier.
130-
* [Samplestack wiki](wiki).
131-
* [MarkLogic product documentation](http://docs-ea.marklogic.com). The credentials are available on the MarkLogic EA download page.
131+
* [Samplestack wiki](https://github.com/marklogic/marklogic-samplestack/wiki).
132+
* [MarkLogic product documentation](http://docs.marklogic.com).
132133

133134
## License
134135

appserver/java-spring/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,10 @@ Start with an out-of-the box MarkLogic server, installed and running. By defaul
2626

2727
* `./gradlew test` This command runs unit tests
2828

29+
*To build javadocs*
30+
31+
* `./gradlew javadoc` These docs are built in build/docs/javadoc
32+
2933
*To use with Eclipse*
3034

3135
See project wiki https://github.com/marklogic/marklogic-samplestack/wiki/Getting-Started-in-Eclipse

0 commit comments

Comments
 (0)