README.md 1.18 KB
Newer Older
Juan Rada's avatar
Juan Rada committed
1 2 3 4
# Bio Studies Backend

## Modules
### Backend Web App
5
Java application that supports the bio studies data submission thought http web services.
Juan Rada's avatar
Juan Rada committed
6 7 8 9 10 11 12 13 14 15

### Core Model
Contains model/database representation classes of Bio-Studies backend application.

### Commons library
Contains utility methods and classes.

### Spreadsheet Readers library
Contains utility methods and classes used to read submissions input files.

16
### Submit Tools
17
Helps to perform submissions through terminal
18 19

### Convert tool
20
Helps to convert between different submissions formats
21

Juan Rada's avatar
Juan Rada committed
22
## Coding standards
23
The project follows the google [java coding standards](https://google.github.io/styleguide/javaguide.html)
Juan Rada's avatar
Juan Rada committed
24 25 26 27 28 29 30 31 32

- [Eclipse formatter](https://github.com/google/styleguide/blob/gh-pages/eclipse-java-google-style.xml)
- [Idea formatter](https://github.com/google/styleguide/blob/gh-pages/intellij-java-google-style.xml)


## Development task

### Importing project

33
Import as gradle project in your favorite IDE
Juan Rada's avatar
Juan Rada committed
34 35 36 37 38 39 40 41 42 43 44 45


### Generating artifact

Run gradle build command either using local distribution or wrapper
 
 ```
  gradlew.bat build (Windows)
  ./gradlew build (Linux)
 ```

Generated war will be available under `BackendWebApp/builds/libs` folder.