TeachUA BackEnd

---

Table of Contents (Optional)

If your README has a lot of info, section headers might be nice.

• Installation
  • Required to install
  • Environment
  • Clone
  • Setup
  • How to run local
• Usage
  • How to work with swagger UI
  • How to run tests
  • How to Checkstyle
• Documentation)
• Contributing
  • git flow
• License

---

Installation

• All the code required to get started
• Images of what it should look like

Required to install

• JDK 8
• PostgreSQL

Environment

environmental variables

WIP

Clone

• Clone this repo to your local machine using https://github.com/ita-social-projects/TeachUA

Setup

WIP

How to run local

WIP

---

Usage

How to work with swagger UI

WIP

How to run tests

• To tun unit and integration test use mvn clean verify -D"checkstyle.skip"=true
• To run unit tests use mvn test -D"checkstyle.skip"=true
• To run integration tests use
  • mvn failsafe:integration-test
  • mvn clean verify -DskipUnitTests -D"checkstyle.skip"=true

Parameters to skip test:

• -DskipTests
• -DskipUnitTests
• -DskipIntegrationTests

How to Checkstyle

• To run checkstyle use mvn validate

To skip checkstyle use

• PowerShell -D"checkstyle.skip"=true
• cmd -Dcheckstyle.skip

Setup Checkstyle

You can read how to set up Checkstyle here

---

Documentation

---

Contributing

Git flow

To get started...

Step 1

WIP

Issue flow

---

FAQ

WIP

---

License

• MIT license
• Copyright 2020 © SoftServe IT Academy.