Caltic Vert.x Wiki

A wiki project based on Vert.x.

Changelog

Changelog:

• release-0.4.0: Refactor using Service Proxy

• release-0.3.1: Make proper documentation using README file

• release-0.3.0: Add user and role management

• release-0.2.0: Refactor using event bus communication

• release-0.1.1: Hotfix DB Pool

• release-0.1.0: Wiki Functionality

• release-0.0.1: Hello World

Prerequisites

• JDK 8+

• Git

• Docker

Getting started

Clone this project:

git clone https://github.com/h3rucutu/caltic-vertx-wiki.git

Set Environment Variable DATABASE_USER and DATABASE_PASSWORD:

export DATABASE_USER=caltic_lab
export DATABASE_PASSWORD=caltic_password

Start PostgreSQL Database using Docker:

docker-compose up -d

Enter to bash container and create schema and seed the dummy user of vertx-auth-jdbc:

$ docker exec -it db_caltic_wiki sh
# psql -U caltic_lab caltic_wiki
caltic_wiki=# QUERY_INSIDE_RESOURCE
caltic_wiki=# \q
# exit

Replace QUERY_INSIDE_RESOURCE with query in vertx_auth_jdbc.sql.

User Matrix

username | password | role   | permission
-----------------------------------------------------
admin    | admin    | admin  | create, update, delete
editor   | editor   | editor | create, update, delete
writer   | writer   | writer | update

Running the project

Once you have completed every steps above, you can running with:

./mvnw clean compile vertx:run

On Windows:

mvnw.cmd clean compile vertx:run

The command compiles the project and run it in redeploy mode. Open your browser to http://localhost:9000. You should be redirected into login page.

Redeploy mode help developer to compile immediately when there’s a changes and deploy it automatically, usually called hot-reload.

Besides run in redeploy mode, you also can package into one jar file:

./mvnw clean compile vertx:package

On Windows:

mvnw.cmd clean compile vertx:package

And run it with java -jar command:

java -jar target/*jar

Heroku Live Test

This project is automated deploy with heroku pipeline.

Branch master caltic-wiki.herokuapp.com

Branch develop caltic-wiki-test.herokuapp.com

What inside the Project?

The technology used on this Project:

• Vert.x stack (core, web, jdbc-client, jdbc-auth, freemarker, unit).

• txtmark

• reactiverse (vertx-maven-plugin)

• logback-classic

• junit

Git-Flow

This project is maintained using git-flow. Please refer git-flow website for the instructions.

TODO

TODO List:

• Modify docker-compose.yml to support running apps inside container.

• Create automated seeding user and roles database.

Caltic.id

This project brought to you by caltic.id