https://github.com/tuyojr/simple-express

https://github.com/tuyojr/simple-express

Last synced: 3 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/tuyojr/simple-express
• Owner: tuyojr
• License: other
• Created: 2022-06-25T09:29:19.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-06-25T09:44:59.000Z (over 2 years ago)
• Last Synced: 2023-03-06T20:56:40.840Z (almost 2 years ago)
• Language: Dockerfile
• Size: 10.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        
# Overview

This is a very simple, bare-bones NodeJS and ExpressJS project created for you to use with Docker.

## Local Setup

**_Note_**: This is only needed if you want to run the app locally. You don't need to install the dependencies or run the server if you are running the code inside a Docker container.

- Install dependencies: `npm install`

- Run server: `node server.js`

## Usage

By default, the application should be loaded on `localhost:8080`. It should provide an HTTP 200 response when loaded at `localhost:8080/health`.

## Container Setup

- Build image: `docker build .`

- Run container with image: `docker run {image_id}` where `image_id` can be retrieved by running `docker images` and found under the column `IMAGE ID`

- You can use the `-d` flag to run the container in the background. This will enable you to run other commands in your terminal while the container is running.

## Container Teardown

- Remove container: `docker kill {container_id}` where `container_id` can be retrieved by running `docker ps` and found under the column `CONTAINER ID`