Current release: Fruit
A group project to develop an app for the office library for 2018 Bristol grads.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
Essential
- Node.js
- Java JDK 8
Suggested
- VSCode for front-end development
- IntelliJ IDEA for back-end development
For Java, setup is fairly simple with IntelliJ
- Open the project at the route directory
- In settings, tell IntelliJ where to find the SDK
- It is also recommended that you install the lombok plugin
- The Java program can then be built and deployed from IntelliJ.
For front-end dependencies run the following command in /src/main/client:
npm i
To run a development version of the app you can use:
npm start
To setup automatic linting in VSCode you can refer to this tutorial or follow these steps:
- Install the Prettier - Code formatter plugin from Esben Petersen and reload
- Go to settings
Ctrl + ,
- Click the three dots on the top left and select Open settings.json
- Insert the following options into the settings json:
"editor.formatOnSave": true
Maven unit tests can be run directly from IntelliJ.
Unit tests can be run with this commmand:
npm test
- This repository has two protected branches, Master and Develop
- All tests must pass before a branch can merge into either of these
- Develop requires a code review with at least two approvals
- New front-end code will be automatically linted using Husky and Prettier
- Feature branches should be named as such: [story number]-[appropriate name]
- Feature branches should be deleted after the pull request has been merged
Both Master and Develop have automatic deployments on Heroku