getting-started/docs/tutorial/our-application/index.md

4.5 KiB

For the rest of this tutorial, we will be working with a simple todo list manager that is running in Node. If you're not familiar with Node, don't worry! No real JavaScript experience is needed!

At this point, your development team is quite small and you're simply building an app to prove out your MVP (minimum viable product). You want to show how it works and what it's capable of doing without needing to think about how it will work for a large team, multiple developers, etc.

Todo List Manager Screenshot{: style="width:50%;" } { .text-center }

Getting our App

Before we can run the application, we need to get the application source code onto our machine. For real projects, you will typically clone the repo. But, for this tutorial, we have created a ZIP file containing the application.

  1. Download the ZIP. Open the ZIP file and make sure you extract the contents.

  2. Once extracted, use your favorite code editor to open the project. If you're in need of an editor, you can use Visual Studio Code. You should see the package.json and two subdirectories (src and spec).

    Screenshot of Visual Studio Code opened with the app loaded{: style="width:650px;margin-top:20px;"} {: .text-center }

Building the App's Container Image

In order to build the application, we need to use a Dockerfile. A Dockerfile is simply a text-based script of instructions that is used to create a container image. If you've created Dockerfiles before, you might see a few flaws in the Dockerfile below. But, don't worry! We'll go over them.

  1. Create a file named Dockerfile with the following contents.

    FROM node:12-alpine
    WORKDIR /app
    COPY . .
    RUN yarn install --production
    CMD ["node", "/app/src/index.js"]
    
  2. Build the container image using the docker build command.

    docker build -t getting-started .
    

    This command used the Dockerfile to build a new container image. You might have noticed that a lot of "layers" were downloaded. This is because we instructed the builder that we wanted to start from the node:12-alpine image. But, since we didn't have that on our machine, that image needed to be downloaded.

    After the image was downloaded, we copied in our application and used yarn to install our application's dependencies. The CMD directive specifies the default command to run when starting a container from this image.

    Finally, the -t flag tags our image. Think of this simply as a human-readable name for the final image. Since we named the image getting-started, we can refer to that image when we run a container.

Starting an App Container

Now that we have an image, let's run the application! To do so, we will use the docker run command (remember that from earlier?).

  1. Start your container using the docker run command and specify the name of the image we just created:

    docker run -dp 3000:3000 getting-started
    

    Remember the -d and -p flags? We're running the new container in "detached" mode (in the background) and creating a mapping between the host's port 3000 to the container's port 3000. Without the port mapping, we wouldn't be able to access the application.

  2. After a few seconds, open your web browser to http://localhost:3000. You should see our app!

    Empty Todo List{: style="width:450px;margin-top:20px;"} {: .text-center }

  3. Go ahead and add an item or two and see that it works as you expect. You can mark items as complete and remove items. Your frontend is successfully storing items in the backend! Pretty quick and easy, huh?

At this point, you should have a running todo list manager with a few items, all built by you! Now, let's make a few changes and learn about managing our containers.

If you take a quick look at the Docker Dashboard, you should see your two containers running now (this tutorial and your freshly launched app container)!

Docker Dashboard with tutorial and app containers running

Recap

In this short section, we learned the very basics about building a container image and created a Dockerfile to do so. Once we built an image, we started the container and saw the running app!

Next, we're going to make a modification to our app and learn how to update our running application with a new image. Along the way, we'll learn a few other useful commands.