README.md

Demo

Link: jmp-app.tk
Username: adam
Password: pass4dev
Backend Pipeline:
Frontend Pipeline:

Table of Contents:

• JMP
• Getting Started
  • Prerequisites
  • Installation
  • Manual Installation
    • Development environment
    • Production environment
  • Development
    • Frontend
    • Backend
• Authors
• License

Getting Started

Prerequisites

Required:

• docker

Recommended:

• GNU Make

Installation

Clone the repository

git clone https://github.com/jmp-app/jmp.git
cd jmp

To run the development environment you only need run the following Make target:

make setup-dev

or for the production environment:

make setup-prod

Note:

• For a real production environment you need to adjust all the environment variables properly. See dotenv.

Manual Installation

There is also a Makefile accessible for the most common tasks: Makefile
Run make help for more information.

Clone the repository

git clone https://github.com/jmp-app/jmp.git
cd jmp

Create the following .env and configuration files from its corresponding example files:

• vue/jmp.config.js
• db.env
• api/db.env
• api/.env

Read more about all variables at dotenv

Development environment

Build vue

docker-compose -f vue-build.yml run npm

Note:

• To run vue at development with a local installation of npm, read this documentation

Build and start the docker containers

docker-compose up -d --build

Install all the dependencies using the composer of the app container

docker exec app composer install

Production environment

Build and start the docker containers

docker-compose -f docker-compose.prod.yml up -d --build

You can now access the frontend at http://localhost and the api at http://localhost/api

Documentation & Development

Check the documentation for further information.

Frontend

Everything related to the frontend is located in vue. The frontend is built with Vue.js.

Backend

Everything related to the backend is located in api. The backend uses the Slim Framework.

Authors

• Simon Friedli - @Simai00
• Dominik Strässle - @dominikstraessle
• Kay Mattern - @mtte

License

This project is licensed under the MIT License - see the LICENSE file for details.