RPGTable

RPGTable is a virtual table which provides a battle plan to support Pen & Paper Role-playing game players.

1. Build it

$ ./bin/build.sh

2. Go into the the newly created dist folder
3. Start it

$ .start.sh

|-- bin
|   |-- build.sh
|   `-- test.sh
|-- browser
|   |-- dist
|   |-- src
|   `-- Gruntfile.js
|-- conf
|-- server
|   |-- src
|   |   |-- main
|   |   `-- test
|   |-- build.gradle
|   |-- dependencies.gradle
|   `-- gradlew
`-- README.md

The bin folder contains scripts to build, start and test the application.

The browser folder contains all files related to the HTML5 client. We chose the name browser instead of client, because this allows us to add an additional client, e. g. an android client, easily.

The server folder contains the back end, which is based on Vert.x

There is no specific IDE you have to use, but there are already Eclipse projects. But especially for the content in folder browser it could make sense to use an IDE which is more HTML5/JavaScript friendly.

We are using Gerrit, so PRs in Github will be ignored. Please use GerritHub.io to contribute changes. The project name is caspal/RPGTable

1. Encoding must be in UTF-8.
2. Change must have a commit message.
3. The line endings must be LF (linux).
4. The maximum length of a line should be between 80 and 120 characters.
5. Use spaces instead of tabs.
6. Use 4 spaces for indentation
   • If the project already uses 2, adapt the project rules
7. No trailing whitespaces.
8. Avoid unnecessary empty lines.
9. Adapt your code to the surroundings.
10. Follow the default language style guide.
    • Java
    • JavaScript