mv-platform

All Marchas Virtuales services started from a single repository

Keep in mind this repository is for local development only and is not meant to be deployed on any production environment!

Requirements

1. Docker
2. Docker Compose

How to run it?

1. Clone the repository:

$ git clone https://github.com/facttic/mv-platform.git --recursive --jobs 3

2. We are using shared folders to enable live code reloading. Without this, Docker Compose will not start (untested for Windows/Mac):

   • Windows/MacOS: Add the cloned mv-platform directory to Docker shared directories (Preferences -> Resources -> File sharing).
   • Windows/MacOS: Make sure that in Docker preferences you have dedicated at least 5 GB of memory (Preferences -> Resources -> Advanced).
   • Linux: No action required, sharing already enabled and memory for Docker engine is not limited.

3. Go to the cloned docker directory:

$ cd mv-platform/docker

4. Build the application:

$ docker-compose build

8. Run the application:

$ docker-compose up

How to update the subprojects to the newest versions?

This repository contains newest stable versions. When new release appear, pull new version of this repository. In order to update all of them to their newest versions, run:

$ git submodule update --remote

You can find the latest version of marchas virtuales api, cron, admin and front in their individual repositories:

• https://github.com/facttic/mv-api
• https://github.com/facttic/mv-cron
• https://github.com/facttic/mv-front
• https://github.com/facttic/mv-admin

How to solve issues with lack of available space or build errors after update

Most of the time both issues can be solved by cleaning up space taken by old containers. After that, we build again whole platform.

1. Make sure docker stack is not running

$ docker-compose stop

2. Remove existing volumes

Warning! Proceeding will remove also your database container! If you need existing data, please remove only services which cause problems! https://docs.docker.com/compose/reference/rm/

docker-compose rm

3. Build fresh containers

docker-compose build

4. Now you can run fresh environment using commands from How to run it? section. Done!

Still no available space

If you are getting issues with lack of available space, consider prunning your docker cache:

Warning! This will remove:

• all stopped containers
• all networks not used by at least one container
• all dangling images
• all dangling build cache

More info: https://docs.docker.com/engine/reference/commandline/system_prune/

I've been warned

$ docker system prune

How to run application parts?

• docker-compose up api cron for backend services only
• docker-compose up for backend and frontend services

Where is the application running?

• MV API - http://localhost:3333/api
• MV Frontend - http://localhost:3000
• MV Admin - http://localhost:3001
• MV Cron - http://localhost:3333