Team Course

Basic introduction to technologies that are commonly used on client engagements
Explore the docs »

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgements

About The Project

This repo holds the introductory Digital Engineering training course. The purpose of the course is to provide a basic introduction to technologies that are commonly used on client engagements.

The course is not meant as an extensive training in the specific technologies, a list or resources have been curated that will be useful for that purpose, as have Udemy channels been setup aligned to the Engineering development paths.

Built With

• Java
• NodeJS
• Gradle
• Docker
• CircleCI
• ElasticSearch
• Kubernetes
• Google Cloud Platform

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• Java 8-11 is required to build and run the application

Installation

# clone the repo
git clone https://github.com/capcodigital/team-course.git

# create virtual environment
pyenv virtualenv 3.9.1 .venv-team-course

# installs the tooling requirements
pip install -r requirements.txt

# installs the git hook for pre-commit
pre-commit install

Usage

Starting MongoDB

To start up the required mongo database, run the following:

docker-compose -f stack.yml up -d if-db

Pre-Requisite / Trouble Shooting

This repo is configured using gradlewrapper of 4.8 version. However if you already have higher version of gradle, and if you attempt to run gradle commands instead of ./gradlew command, you will see some errors like Could not find method compile(), as its removed from latest gradle versions.

Manage multiple version of gradle in your local machine checkout sdkman.

This is version manager for many tools like gradle, groovy. Install it following the instructions and then it's pretty easy to use for macOS / Linux.

To check available versions

sdk list gradle

To install and user particular version

sdk install gradle 7.0
sdk use gradle 7.0

Clean, Build & Run the Application

To clean, build and run the application execute the following command:

./gradlew clean build bootRun

Running Application in Docker

To build the application as a docker file, run the following:

./gradlew docker

Running Required Dependencies using Docker

To run the required dependencies using docker containers, run:

docker-compose -f stack.yml up -d

Test Coverage Report

To generate a Jacoco test coverage report, run:

./gradlew clean check

The report can be viewed at:

/digital-engineering-course/build/reports/jacoco/test/html/index.html

Running the Application

To run the application itself, run:

docker run -d -p 8090:8090 --name digitalengineeringcourse manucapco/digitalengineeringcourse:latest

You should be able to access the following page here

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

If you would like to contribute to any Capco Digital OSS projects please read:

• Code of Conduct
• Contributing Guidelines

License

Distributed under the MIT License. See LICENSE for more information.

Acknowledgements

• Best README Template