Quick start guide for development

Clone the repository:

git clone https://github.com/plankes-projects/splitastic.git

Setup Server

• Prepare a MySQL server
• Create server/app/application.properties from server/app/application.properties.template
• Fill server/app/application.properties (view server/README.md for more information)
• install java
• Go into the directory server/ and run (or start the server in your IDE):

mvnw install
java -jar app/target/app-0.0.1-SNAPSHOT.jar --spring.config.location=app/application.properties

See server/README.md for server specific dev notes.

Setup Client

• Create clients/vue/config.ts from clients/vue/config.ts.template
• Fill clients/vue/config.ts
• Install npm on your system (https://www.npmjs.com/get-npm)
• Install vue-cli (https://cli.vuejs.org/)
• Go into the directory clients/vue/ and run following for a client with code hot reload:

npm run serve

See clients/vue/README.md for client specific dev notes.

Development Notes

Branching standards & conventions

https://gist.github.com/digitaljhelms/4287848

TODOs:

TODOs are tracked on: https://github.com/plankes-projects/splitastic/projects/1

New server API endpoints:

API endpoints are implemented with server/specification/src/main/resources/openapi.yml (see https://swagger.io/tools/swagger-editor/). Afterwards client and server parts are generated from this file (see readme in server/client).

Fast login

Use the admin token to enable instant login. See server readme for more details.