micro-company

(โ˜… 362)

Rest-full, Hipermedia-based distributed application. Spring boot & cloud. Angular. CQRS. Eventsourcing. Axonframework. Microservices. Docker. CloudFoundry

  • .gitattributes
  • .gitignore
  • _config.yml
  • CODE_OF_CONDUCT.md
  • gh-md-toc
  • LICENSE
  • micro-company.PNG
  • mvnw
  • mvnw.cmd
  • pom.xml
  • README.md

# Installation Guide

1. Get the code
git clone https://github.com/idugalic/micro-company

Downloads the entire project code from GitHub to your computer.

cd micro-company

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
$ DOCKER_HOST=unix:///var/run/docker.sock mvn docker:build

Installs dependencies and builds the project using Maven.

$ DOCKER_HOST=unix:///var/run/docker.sock mvn docker:build -DpushImage

Installs dependencies and builds the project using Maven.

$ cd micro-company/docker

Type this command into your terminal and run it.

$ docker-compose -f docker-compose-monolithic.yml up -d

Runs the command against the services defined in the compose file.

$ docker-compose up -d

Runs the command against the services defined in the compose file.

โœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

3. Maven (Java)

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • JDK (Java) Required to build and run Java projects.
  • Maven The build tool used for the mvn command.
$ mvn clean install

Installs dependencies and builds the project using Maven.

$ DOCKER_HOST=unix:///var/run/docker.sock mvn docker:build

Installs dependencies and builds the project using Maven.

$ DOCKER_HOST=unix:///var/run/docker.sock mvn docker:build -DpushImage

Installs dependencies and builds the project using Maven.

$ mvn spring-boot:run

Installs dependencies and builds the project using Maven.

โœ… A BUILD SUCCESS message means it worked. The output is created under target/.

Pulled directly from this repo's README.

4. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
โš ๏ธ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
cd monolithic/src/main/frontend

This project's files live in a subfolder, so move into it first.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

โœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.
// repository documentation