diff --git a/README.md b/README.md index 72a0664..c8c8f4e 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,14 @@ # NoDock -Docker Compose for Node projects with Node, MySQL, MongoDB, NGINX, Memcached,Certbot and RabbitMQ images +Docker Compose for Node projects with Node, MySQL, MongoDB, NGINX, Memcached, Certbot and RabbitMQ images + + +## Why NoDock? + +The [docker Node.js](https://github.com/nodejs/docker-node) image is very simple, you give it an entrypoint and it runs it. This is fine for very simple/small scripts but for larger projects you'll probably want something a bit more robust. + +The goal of NoDock is to provide a complete environment for your node project: Node.js service(s), databases, web servers, queues, etc. while doing the "wiring" for you. + +You can use NoDock for simple projects by using one of the [examples](#Examples) or you can build upon them. ## Contents diff --git a/_examples/memcached/README.md b/_examples/memcached/README.md index 6121cdb..caed4f9 100644 --- a/_examples/memcached/README.md +++ b/_examples/memcached/README.md @@ -7,8 +7,7 @@ Copy the index file in this folder to the project root: ```bash cd / -cp nodock/_examples/memcached/index.js . -cp nodock/_examples/memcached/package.json . +cp -r nodock/_examples/memcached/* . ``` ### Usage @@ -19,4 +18,4 @@ cd nodock/ docker-compose up -d memcached node nginx ``` -By going to `127.0.0.1` in your browser you should be seeing a message indicating that `node` has successfully connected to `memcached`. \ No newline at end of file +By going to `127.0.0.1` in your browser you should be seeing a message indicating that `node` has successfully connected to `memcached`. diff --git a/_examples/mongo/README.md b/_examples/mongo/README.md index 61214ba..8b920b9 100644 --- a/_examples/mongo/README.md +++ b/_examples/mongo/README.md @@ -7,8 +7,7 @@ Copy the index file in this folder to the project root: ```bash cd / -cp nodock/_examples/mongo/index.js . -cp nodock/_examples/mongo/package.json . +cp -r nodock/_examples/mongo/* . ``` ### Usage @@ -19,4 +18,4 @@ cd nodock/ docker-compose up -d mongo node nginx ``` -By going to `127.0.0.1` in your browser you should be seeing a message indicating that `node` has successfully connected to `mongo`. \ No newline at end of file +By going to `127.0.0.1` in your browser you should be seeing a message indicating that `node` has successfully connected to `mongo`. diff --git a/_examples/mysql/README.md b/_examples/mysql/README.md index e95a7e3..dc51a90 100644 --- a/_examples/mysql/README.md +++ b/_examples/mysql/README.md @@ -7,8 +7,7 @@ Copy the index file in this folder to the project root: ```bash cd / -cp nodock/_examples/mysql/index.js . -cp nodock/_examples/mysql/package.json . +cp -r nodock/_examples/mysql/* . ``` ### Usage @@ -19,4 +18,4 @@ cd nodock/ docker-compose up -d mysql node nginx ``` -By going to `127.0.0.1` in your browser you should be seeing a message indicating that `node` has successfully connected to `mysql`. \ No newline at end of file +By going to `127.0.0.1` in your browser you should be seeing a message indicating that `node` has successfully connected to `mysql`. diff --git a/_examples/rabbitmq/README.md b/_examples/rabbitmq/README.md index b579f63..e4474eb 100644 --- a/_examples/rabbitmq/README.md +++ b/_examples/rabbitmq/README.md @@ -7,8 +7,7 @@ Copy the index file in this folder to the project root: ```bash cd / -cp nodock/_examples/rabbitmq/index.js . -cp nodock/_examples/rabbitmq/package.json . +cp -r nodock/_examples/rabbitmq/* . ``` ### Usage @@ -19,4 +18,4 @@ cd nodock/ docker-compose up -d rabbitmq node nginx ``` -By going to `127.0.0.1` in your browser you should be seeing a message indicating that `node` has successfully connected to `rabbitmq`. If you are seeing an error message, wait a few seconds for RabbitMQ to spin up and reload the page. \ No newline at end of file +By going to `127.0.0.1` in your browser you should be seeing a message indicating that `node` has successfully connected to `rabbitmq`. If you are seeing an error message, wait a few seconds for RabbitMQ to spin up and reload the page. diff --git a/_examples/simple-web/README.md b/_examples/simple-web/README.md index b839b7e..867ac3c 100644 --- a/_examples/simple-web/README.md +++ b/_examples/simple-web/README.md @@ -7,8 +7,7 @@ Copy the index file in this folder to the project root: ```bash cd / -cp nodock/_examples/simple-web/index.js . -cp nodock/_examples/simple-web/package.json . +cp -r nodock/_examples/simple-web/* . ``` ### Usage @@ -19,4 +18,4 @@ cd nodock/ docker-compose up -d node nginx ``` -By going to `127.0.0.1` in your browser you should be seeing a nice greeting! \ No newline at end of file +By going to `127.0.0.1` in your browser you should be seeing a nice greeting!