INSERT GRAPHIC HERE (include hyperlink in image)

Repository Title Goes Here

Subtitle or Short Description Goes Here

ideally one sentence

include terms/tags that can be searched

Badges will go here

• build status
• coverage
• issues (waffle.io maybe)
• devDependencies
• npm package
• slack
• downloads
• gitter chat
• license
• etc.

• For more on these wonderful badges, refer to shields.io.

---

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
  • How to run Docker
• Usage
  • How to work with swagger UI
  • How to run tests
  • How to Checkstyle
• Documentation)
• Contributing
  • git flow
  • issue flow
• FAQ
• Support
• License

---

Installation

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

Required to install

• Python (3.6.3)
• PostgreSQL (9.5.9)
• Django (1.11.6)
• NodeJS (6.11.4)
• Redis (3.0.6)

Environment

environmental variables

spring.datasource.url=${DATASOURCE_URL}
spring.datasource.username=${DATASOURCE_USER}
spring.datasource.password=${DATASOURCE_PASSWORD}
spring.mail.username=${EMAIL_ADDRESS}
spring.mail.password=${EMAIL_PASSWORD}
cloud.name=${CLOUD_NAME}
api.key=${API_KEY}
api.secret=${API_SECRET}

Clone

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

Setup

• If you want more syntax highlighting, format your code like this:

update and install this package first

$ brew update
$ brew install SOMEREPOproductions

now install npm and bower packages

$ npm install
$ bower install

• For all the possible languages that support syntax highlithing on GitHub (which is basically all of them), refer here.

How to run local

How to run Docker

---

Usage

How to work with swagger UI

How to run tests

How to Checkstyle

---

Documentation

---

Contributing

Project setup

Start with our wiki (TBD) to set up the environment and deploy the project locally

Git Flow

We are using simplest GitHub flow to organize our work:

Note! Contribution rules:

1. All Pull Requests should start from prefix #xxx-yyy where xxx - task number and yyy - short description e.g. #020-CreateAdminPanel
2. Pull requests should not contain any files not required by the task.

In case of any violations, the pull request will be rejected.

---

Team

Or Contributors/People

• You can just grab their GitHub profile image URL
• You should probably resize their picture using ?s=200 at the end of the image URL.

---

FAQ

• How do I do specifically so and so?
  • No problem! Just do this.

---

Support

Reach out to me at one of the following places!

• Website at Website.com
• Facebook at Liubomyr Halamaha
• Insert more social links here.

---

License

• MIT license
• Copyright 2020 © SoftServe IT Academy.