Commit 319ba6f6 authored by Raphael Mäder's avatar Raphael Mäder

Update README

parent 1db25908
# Play-CMS Demo #
This is a Play framework demo application built with [insign](http://www.insign.ch)s **play-cms** - a java-based Play
This is a Play framework demo application built with [insign](http://www.insign.ch)'s **play-cms** - a java-based Play
framework CMS.
This demo creates some demo content and uses the h2 in-memory db for storage. It is intended to be used as
This project creates some demo content and uses a h2 in-memory db for storage. It is intended to be used as
quick-and-easy starting point for your own play-cms project. We've also added a docker-based devops setup for a CI
(continuous integration) process.
......@@ -12,8 +12,7 @@ Check out the [play-cms](http://www.play-cms.com) website for more information a
## Quick start
Either do a local installation (if you have the sbt installed) using H2 by default, or run it with Docker which
uses MySQL database by default.
Either do a local installation using H2 by default, or run it with Docker which uses a MySQL database by default.
### Local installation ###
......@@ -25,6 +24,9 @@ By default, the application will be running on [http://localhost:9000/]() and us
After starting up the application, you need to execute the bootstrap code by calling [http://localhost:9000/reset](),
otherwise you will get an error.
Be aware that you won't be able to use the file manager for adding images/files to the WYSIWYG editor. For that,
you'd have to use the dockerized setup (instructions below).
### Backend Access ###
Default admin page url: [http://localhost:9000/admin]()
......@@ -37,48 +39,44 @@ Default admin page url: [http://localhost:9000/admin]()
## Development environment and Continuous Integration ##
The project contains both a development environment and continuous integration setup (based on docker) for quick
starting new projects.
starting new projects.
### Use the development environment ###
- Make sure you have `docker` and `sbt` installed
- SBT options can be specified in `./.sbtopts` file, but it must be noted that a line feed is required at file end
because otherwise the last option will be ignored by sbt
- SBT options can be specified in `./.sbtopts` file. It must be noted that a line feed is required at the end of
the file because otherwise the last option will be ignored by sbt
- To enable based on docker environment execute the following command in your project root folder:
-cp .sbtopts-example .sbtopts
cp .sbtopts-example .sbtopts
To quick start the project with this setup, run
sbt run
The application will be running on [http://localhost:9000/]().
The environment features these dockerized applications:
- MySQL on port 3306, database: db_play-cms-demo, user: play-cms-demo, password: s3cr3t
- MySQL on port 3306, database: db_play-cms-demo, user: play-cms-demo, password: s3cr3t (can be changed in `build.sbt`)
- Mailhog SMTP server and mail viewer under [http://localhost:8025/]()
- Filemanager under [http://localhost:8035/]()
As with the setup not using docker, you will have to call the `/reset` route after starting the application for the
first time.
Sometimes(depends from your OS system settings: umask) you will need add permissions in ./data folder (where all docker volumes mapped)
Sometimes (depending on your OS' `umask` settings) you will need add permissions in ./data folder (where all docker
volumes are mapped)
### Developing the play modules ##
If you want to develop the play-cms modules, uncomment next line in `./.sbtopts` file:
```
-Dplaycms.version=local
```
-Dplaycms.version=local
Then execute the following commands in your project root folder:
```
mkdir modules
cd modules
git clone ssh://git@sshgit.insign.rocks:10022/open-source/play-cms/play-cms.git
```
cd ..
git clone ssh://git@sshgit.insign.rocks:10022/open-source/play-cms/play-cms.git
## Developing the demo project itself ##
......@@ -92,7 +90,7 @@ Credentials will be asked on first time.
Note: bintray doesn't support snapshots.
Current version of a module can be easily removed from bintray with
The current version of a module can be easily removed from bintray with
sbt bintrayUnpublish
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment