From efa461f83bed41cde6d504ffeedb842e5c5a45e8 Mon Sep 17 00:00:00 2001 From: Anca Iordache Date: Fri, 6 Mar 2020 15:04:03 +0100 Subject: [PATCH] update README.md Signed-off-by: Anca Iordache --- README.md | 44 ++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 40 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index c2a7716..6058481 100644 --- a/README.md +++ b/README.md @@ -2,15 +2,51 @@ ![logo](awesome-compose.jpg) -> A curated list of Compose files +> A curated list of docker-compose application samples. +The purpose of these samples is to provide a quick start on how to integrate different services with a Compose file and to quickly manage their deployment with docker-compose. -Compose files are used to define container-based application and deploy them. + +## Getting Started + +These instructions will get you through the bootstrap phase of creating and deploying samples of containerized applications with docker-compose. + + +### Prerequisites + +Make sure you have docker and docker-compose installed. Download all or any of the samples in the `samples` directory. + +### Running a sample + +The root directory of each sample contains the docker-compose.yaml describing the configuration of service components. All samples can be run in local environment by going into the root directory of each one and doing: +``` +docker-compose up -d +``` +Check the `README.md` of each sample to get more details on the structure and what is the expected output. +To stop and remove the running containers of the sample application do: +``` +docker-compose down +``` ## Contents -- [List item](http://example.com) -- [List item](http://example.com) +*Samples of docker-compose applications with multiple integrated services:* + +- [`Asp.NET/MS-SQL`](samples/aspnet-mysql/README.md) -- sample asp\\.net core application with MySQL database +- [`Flask / NGINX / MySQL`](samples/nginx-flask-mysql/README.md) -- sample Python/Flask application with an Nginx proxy and a MySQL database +- [`Go / NGINX / MySQL`](samples/nginx-golang-mysql/README.md) -- sample Go application with an Nginx proxy and a MySQL database +- [`Go / NGINX / PostgreSQL`](samples/nginx-golang-postgres/README.md) -- sample Go application with an Nginx proxy and a PostgreSQL database +- [`Java / MySQL`](samples/sparkjava-mysql/README.md) -- sample Java application and a MySQL database +- [`NGINX / Go`](samples/nginx-gohttp_1/README.md) -- sample Nginx application with a Go backend +- [`NGINX / Go`](samples/nginx-gohttp_2/README.md) -- another Nginx sample application with a Go backend +- [`React / Spring / MySQL`](samples/react-java-mysql/README.md) -- sample React application with a Spring backend and a MySQL database +- [`React / Express / MySQL`](samples/react-express-mysql/README.md) -- sample React application with a NodeJS backend and a MySQL database +- [`Spring / PostgreSQL`](samples/spring-postgres/README.md) -- sample Java application with Spring framework and a Postgres database + + +*Single service samples:* +- [`Angular`](samples/angular/README.md) +- [`VueJS`](samples/vuejs/README.md) ## Contribute