Run sagan to test your own content

To write your own guide, it's handy to test out your changes locally.

1. git clone [email protected]:spring-io/sagan.git
2. cd sagan
3. Edit Sagan's configuration to use your gs- repository.
4. ./gradlew clean :sagan-renderer:bootRun
5. ./gradlew clean :sagan-site:bootRun
6. Visit http://localhost:8080/guides

This process will check out and run the sagan app on your local machine.

NOTE: You must have Java 8 to do so

Any projects in your own GitHub space that start with "gs-*" will be listed underneath the guides. Certain caching features may be in place, so sometimes, it's easier to shut down and re-start the app the see your edits.

Also be advised, that to make edits to your guide, you MUST push them to your GitHub space. When your guide appears sufficiently edited, continue with the submission process.