Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/nickjj/docker-node-example

An example Node / Express app that's using Docker and Docker Compose.
https://github.com/nickjj/docker-node-example

docker docker-compose esbuild express node postgres redis tailwindcss

Last synced: 3 months ago
JSON representation

An example Node / Express app that's using Docker and Docker Compose.

Awesome Lists containing this project

README 

          
# 🐳 An example Node + Docker app



You could use this example app as a base for your new project or as a guide to

Dockerize your existing Node app.



The example app is minimal but it wires up a number of things you might use in

a real world Node app, but at the same time it's not loaded up with a million

personal opinions.



For the Docker bits, everything included is an accumulation of [Docker best

practices](https://nickjanetakis.com/blog/best-practices-around-production-ready-web-apps-with-docker-compose)

based on building and deploying dozens of assorted Dockerized web apps since

late 2014.



**This app is using Express 5.1.0 and Node 22.17.0**. The screenshot shows

`X.X.X` since they get updated regularly:



[![Screenshot](.github/docs/screenshot.jpg)](https://github.com/nickjj/docker-node-example/blob/main/.github/docs/screenshot.jpg?raw=true)



## 🧾 Table of contents



- [Tech stack](#tech-stack)

- [Notable opinions and packages](#notable-opinions-and-packages)

- [Running this app](#running-this-app)

- [Files of interest](#files-of-interest)

  - [`.env`](#env)

  - [`run`](#run)

- [Running a script to automate renaming the project](#running-a-script-to-automate-renaming-the-project)

- [Updating dependencies](#updating-dependencies)

- [See a way to improve something?](#see-a-way-to-improve-something)

- [Additional resources](#additional-resources)

  - [Learn more about Docker and Node](#learn-more-about-docker-and-node)

  - [Deploy to production](#deploy-to-production)

- [About the author](#about-the-author)



## 🧬 Tech stack



If you don't like some of these choices that's no problem, you can swap them

out for something else on your own.



### Back-end



- [PostgreSQL](https://www.postgresql.org/)

- [Objection.js / Knex](https://github.com/vincit/objection.js)

- [Redis](https://redis.io/)



### Front-end



- [esbuild](https://esbuild.github.io/)

- [TailwindCSS](https://tailwindcss.com/)

- [Heroicons](https://heroicons.com/)



#### But what about client side JavaScript?!



Picking a JS library is a very app specific decision because it depends on

which library you like and it also depends on if your app is going to be

mostly EJS templates with sprinkles of JS or an API back-end.



This isn't an exhaustive list but here's a few reasonable choices depending on

how you're building your app:



- 

- 

- 

- 

- 

- 



On the bright side with esbuild being set up you can use any (or none) of these

solutions very easily. You could follow a specific library's installation

guides to get up and running in no time.



Personally I'm going to be using Hotwire Turbo + Stimulus in most newer

projects.



## 🍣 Notable opinions and packages



Express is a very very unopinionated framework and let me preface this by

saying I'm not primarily a Node developer. Most of these design choices are

based on experience using other web frameworks and Googling for Node specifics.



If you find yourself face palming or see a way to improvement something please

open an issue or PR.



- **Packages and middleware**:

    - *[morgan](https://github.com/expressjs/morgan)* for logging HTTP requests

    - *[express-ejs-layouts](https://github.com/soarez/express-ejs-layouts/)* for using EJS with layouts

    - *[nodemon](https://github.com/remy/nodemon)* for code reloading in development

    - Redis based session middleware is enabled

    - Static file middleware is enabled

- **Linting and testing**:

    - *[eslint](https://github.com/eslint/eslint)* is used to lint the code base using `airbnb-base`

    - *[jest](https://github.com/facebook/jest)* for writing tests and reporting test coverage

- **Routes**:

    - Add `page` route to render a home page

    - Add `up` route to provide a few health check pages

- **Config**:

    - Log to STDOUT so that Docker can consume and deal with log output

    - Extract a bunch of configuration settings into environment variables

    - `backend/config/index.js` and the `.env` file handles configuration in all environments

- **Front-end assets**:

    - `frontend/` contains all your CSS, JS, images, fonts, etc. and is managed by esbuild

    - Custom `502.html` and `maintenance.html` pages

    - Generate favicons using modern best practices

- **Express defaults that are changed**:



    - `public/` is the static directory where Express will serve static files from



Besides the Node app itself:



- Docker support has been added which would be any files having `*docker*` in

  its name

- GitHub Actions have been set up



## 🚀 Running this app



You'll need to have [Docker installed](https://docs.docker.com/get-docker/).

It's available on Windows, macOS and most distros of Linux. If you're new to

Docker and want to learn it in detail check out the [additional resources

links](#learn-more-about-docker-and-node) near the bottom of this

README.



You'll also need to enable Docker Compose v2 support if you're using Docker

Desktop. On native Linux without Docker Desktop you can [install it as a plugin

to Docker](https://docs.docker.com/compose/install/linux/). It's been generally

available for a while now and is stable. This project uses specific [Docker

Compose v2

features](https://nickjanetakis.com/blog/optional-depends-on-with-docker-compose-v2-20-2)

that only work with Docker Compose v2 2.20.2+.



If you're using Windows, it will be expected that you're following along inside

of [WSL or WSL

2](https://nickjanetakis.com/blog/a-linux-dev-environment-on-windows-with-wsl-2-docker-desktop-and-more).

That's because we're going to be running shell commands. You can always modify

these commands for PowerShell if you want.



#### Clone this repo anywhere you want and move into the directory:



```sh

git clone https://github.com/nickjj/docker-node-example hellonode

cd hellonode



# Optionally checkout a specific tag, such as: git checkout 0.7.0

```



#### Copy an example .env file because the real one is git ignored:



```sh

cp .env.example .env

```



#### Build everything:



*The first time you run this it's going to take 5-10 minutes depending on your

internet connection speed and computer's hardware specs. That's because it's

going to download a few Docker images and build the Node + Yarn dependencies.*



```sh

docker compose up --build

```



Now that everything is built and running we can treat it like any other Node

app.



Did you receive a `depends_on` "Additional property required is not allowed"

error? Please update to at least Docker Compose v2.20.2+ or Docker Desktop

4.22.0+.



Did you receive an error about a port being in use? Chances are it's because

something on your machine is already running on port 8000. Check out the docs

in the `.env` file for the `DOCKER_WEB_PORT_FORWARD` variable to fix this.



Did you receive a permission denied error? Chances are you're running native

Linux and your `uid:gid` aren't `1000:1000` (you can verify this by running

`id`). Check out the docs in the `.env` file to customize the `UID` and `GID`

variables to fix this.



#### Check it out in a browser:



Visit  in your favorite browser.



#### Linting the code base:



```sh

# You should get no output (that means everything is operational).

./run lint

```



*There's also a `./run quality` command to lint and format all files. We'll go

over that `./run` script in a bit!*



#### Running the test suite:



```sh

# You should see all passing tests. Warnings are typically ok.

./run test

```



#### Stopping everything:



```sh

# Stop the containers and remove a few Docker related resources associated to this project.

docker compose down

```



You can start things up again with `docker compose up` and unlike the first

time it should only take seconds.



## 🔍 Files of interest



I recommend checking out most files and searching the code base for `TODO:`,

but please review the `.env` and `run` files before diving into the rest of the

code and customizing it. Also, you should hold off on changing anything until

we cover how to customize this example app's name with an automated script

(coming up next in the docs).



### `.env`



This file is ignored from version control so it will never be commit. There's a

number of environment variables defined here that control certain options and

behavior of the application. Everything is documented there.



Feel free to add new variables as needed. This is where you should put all of

your secrets as well as configuration that might change depending on your

environment (specific dev boxes, CI, production, etc.).



### `run`



You can run `./run` to get a list of commands and each command has

documentation in the `run` file itself.



It's a shell script that has a number of functions defined to help you interact

with this project. It's basically a `Makefile` except with [less

limitations](https://nickjanetakis.com/blog/replacing-make-with-a-shell-script-for-running-your-projects-tasks).

For example as a shell script it allows us to pass any arguments to another

program.



This comes in handy to run various Docker commands because sometimes these

commands can be a bit long to type. Feel free to add as many convenience

functions as you want. This file's purpose is to make your experience better!



*If you get tired of typing `./run` you can always create a shell alias with

`alias run=./run` in your `~/.bash_aliases` or equivalent file. Then you'll be

able to run `run` instead of `./run`.*



## ✨ Running a script to automate renaming the project



The app is named `hello` right now but chances are your app will be a different

name. Since the app is already created we'll need to do a find / replace on a

few variants of the string "hello" and update a few Docker related resources.



And by we I mean I created a zero dependency shell script that does all of the

heavy lifting for you. All you have to do is run the script below.



#### Run the rename-project script included in this repo:



```sh

# The script takes 2 arguments.

#

# The first one is the lower case version of your app's name, such as myapp or

# my_app depending on your preference.

#

# The second one is used for your app's module name. For example if you used

# myapp or my_app for the first argument you would want to use MyApp here.

bin/rename-project myapp MyApp

```



The [bin/rename-project

script](https://github.com/nickjj/docker-node-example/blob/main/bin/rename-project)

is going to:



- Remove any Docker resources for your current project

- Perform a number of find / replace actions

- Optionally initialize a new git repo for you



*Afterwards you can delete this script because its only purpose is to assist in

helping you change this project's name without depending on any complicated

project generator tools or 3rd party dependencies.*



If you're not comfy running the script or it doesn't work for whatever reasons

you can [check it

out](https://github.com/nickjj/docker-node-example/blob/main/bin/rename-project)

and perform the actions manually. It's mostly running a find / replace across

files and then renaming a few directories and files.



#### Start and setup the project:



This won't take as long as before because Docker can re-use most things.



```sh

docker compose up --build

```



#### Sanity check to make sure the tests still pass:



It's always a good idea to make sure things are in a working state before

adding custom changes.



```sh

# Then in a 2nd terminal once it's up and ready.

./run quality

./run test

```



If everything passes now you can optionally `git add -A && git commit -m

"Initial commit"` and start customizing your app. Alternatively you can wait

until you develop more of your app before committing anything. It's up to you!



#### Tying up a few loose ends:



You'll probably want to create a fresh `CHANGELOG.md` file for your project. I

like following the style guide at  but feel free

to use whichever style you prefer.



Since this project is MIT licensed you should keep my name and email address in

the `LICENSE` file to adhere to that license's agreement, but you can also add

your name and email on a new line.



If you happen to base your app off this example app or write about any of the

code in this project it would be rad if you could credit this repo by linking

to it. If you want to reference me directly please link to my site at

. You don't have to do this, but it would be very

much appreciated!



## 🛠 Updating dependencies



You can run `./run yarn:outdated` or `./run yarn:outdated:frontend` to get a

list of outdated dependencies based on what you currently have installed. Once

you've figured out what you want to update, go make those updates in your

`backend/package.json` and / or `frontend/package.json` file.



Or, let's say you've customized your app and it's time to add a new dependency,

for the front-end or back-end.



#### In development:



##### Option 1



1. Directly edit `backend/package.json` or `frontend/package.json` to add your package

2. `./run deps:install` or `./run deps:install --no-build`

    - The `--no-build` option will only write out a new lock file without re-building your image



##### Option 2



1. Run `./run yarn add mypackage --no-lockfile` or `./run yarn:frontend add mypackage --no-lockfile` which will update that specific `package.json` with the latest version of that package but not install it

2. The same step as step 2 from option 1



Either option is fine, it's up to you based on what's more convenient at the

time. You can modify the above workflows for updating an existing package or

removing one as well.



You can also access `yarn` in Docker with `./run yarn` and `./run yarn:frontend`

after you've upped the project.



#### In CI:



You'll want to run `docker compose build` since it will use any existing lock

files if they exist. You can also check out the complete CI test pipeline in

the [run](https://github.com/nickjj/docker-node-example/blob/main/run) file

under the `ci:test` function.



#### In production:



This is usually a non-issue since you'll be pulling down pre-built images from

a Docker registry but if you decide to build your Docker images directly on

your server you could run `docker compose build` as part of your deploy

pipeline which is similar to how it would work in CI.



## 🤝 See a way to improve something?



If you see anything that could be improved please open an issue or start a PR.

Any help is much appreciated!



## 🌎 Additional resources



Now that you have your app ready to go, it's time to build something cool! If

you want to learn more about Docker, Node and deploying a Node app here's a

couple of free and paid resources. There's Google too!



### Learn more about Docker and Node



#### Official documentation



- 

- 



#### Courses



- [https://diveintodocker.com](https://diveintodocker.com?ref=docker-node-example)

  is a course I created which goes over the Docker and Docker Compose

  fundamentals



### Deploy to production



I'm creating an in-depth course related to deploying Dockerized web apps. If

you want to get notified when it launches with a discount and potentially get

free videos while the course is being developed then [sign up here to get

notified](https://nickjanetakis.com/courses/deploy-to-production).



## 👀 About the author



- Nick Janetakis |  | [@nickjanetakis](https://twitter.com/nickjanetakis)



I'm a self taught developer and have been freelancing for the last ~20 years.

You can read about everything I've learned along the way on my site at

[https://nickjanetakis.com](https://nickjanetakis.com/).



There's hundreds of [blog posts](https://nickjanetakis.com/blog) and a couple

of [video courses](https://nickjanetakis.com/courses) on web development and

deployment topics. I also have a [podcast](https://runninginproduction.com)

where I talk with folks about running web apps in production.