From 36472c1c68d79010667ba81276deeb92a0c7e5b5 Mon Sep 17 00:00:00 2001 From: Sheersh Date: Mon, 3 Nov 2025 01:30:30 +0530 Subject: [PATCH] feat:Updated-README.md --- README.md | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 52 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3c6ef2da8..71fd1ad6a 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,55 @@ # Getting started -This repository is a sample application for users following the getting started guide at https://docs.docker.com/get-started/. +#This repository is a sample application for users following the getting started guide at https://docs.docker.com/get-started/. -The application is based on the application from the getting started tutorial at https://github.com/docker/getting-started \ No newline at end of file + +# Getting Started Todo App + +This project provides a sample todo list application. It demonstrates all of +the current Docker best practices, ranging from the Compose file, to the +Dockerfile, to CI (using GitHub Actions), and running tests. It's intended to +be well-documented to ensure anyone can come in and easily learn. + +## Application architecture + +![image](https://github.com/docker/getting-started-todo-app/assets/313480/c128b8e4-366f-4b6f-ad73-08e6652b7c4d) + + +This sample application is a simple React frontend that receives data from a +Node.js backend. + +When the application is packaged and shipped, the frontend is compiled into +static HTML, CSS, and JS and then bundled with the backend where it is then +served as static assets. So no... there is no server-side rendering going on +with this sample app. + +During development, since the backend and frontend need different dev tools, +they are split into two separate services. This allows [Vite](https://vitejs.dev/) +to manage the React app while [nodemon](https://nodemon.io/) works with the +backend. With containers, it's easy to separate the development needs! + +## Development + +To spin up the project, simply install Docker Desktop and then run the following +commands: + +``` +git clone https://github.com/docker/getting-started +cd getting-started-todo-app +docker compose up --watch +``` + +You'll see several container images get downloaded from Docker Hub and, after a +moment, the application will be up and running! No need to install or configure +anything on your machine! + +Simply open to [http://localhost](http://localhost) to see the app up and running! + +Any changes made to either the backend or frontend should be seen immediately +without needing to rebuild or restart the containers. + +To help with the database, the development stack also includes phpMyAdmin, which +can be accessed at [http://db.localhost](http://db.localhost) (most browsers will +resolve `*.localhost` correctly, so no hosts file changes should be required). + +### Tearing it down