dev-project-conventions.md

# Coding Project Conventions

[TOC]

CGDS relies on guidelines for the standardization and organization of projects to ensure the structural quality of our
software. Following these guidelines benefits us in multiple areas of software development as well as the streamlining
of maintenance.

## Languages

|Language   |Version        |Linting Tool   |Package Manager|
|---        |---            |---            |---            |
|[Python](https://www.python.org/)     |3.7.5          |[pylint](https://www.pylint.org/)         |[pipenv](https://pipenv-fork.readthedocs.io/en/latest/) or [Conda](https://docs.conda.io/en/latest/)|
|[Javascript](https://developer.mozilla.org/en-US/docs/Web/JavaScript) |[ECMAScript 6](https://developer.mozilla.org/en-US/docs/Web/JavaScript/New_in_JavaScript/ECMAScript_2015_support_in_Mozilla)   |[ESLint](https://eslint.org/)         |[yarn](https://yarnpkg.com/lang/en/)           |
|[Java](https://openjdk.java.net/)     |OpenJDK JDK 13    |[Checkstyle](https://github.com/checkstyle/checkstyle) |[Maven](https://maven.apache.org/)|

## Containerization

* [Docker](https://www.docker.com/)

## Deployment and Provisioning Tools

* [Ansible](https://www.ansible.com/)
* [Terraform](https://www.terraform.io/)

## Frameworks

|Language   |Type           | Framework                                                 |
|---        |---            |---                                                        |
|Python     |REST           | [Flask](https://www.fullstackpython.com/flask.html)       |
|Javascript |Microservice   | [Node.js](https://nodejs.org/en/)                         |
|Javascript |Front-end      | [Vue.js](https://vuejs.org/)                              |