1 Commits

Author SHA1 Message Date
5c00d3230e Bump http-cache-semantics from 4.1.0 to 4.1.1
Bumps [http-cache-semantics](https://github.com/kornelski/http-cache-semantics) from 4.1.0 to 4.1.1.
- [Commits](https://github.com/kornelski/http-cache-semantics/compare/v4.1.0...v4.1.1)

---
updated-dependencies:
- dependency-name: http-cache-semantics
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2023-07-17 17:19:01 +00:00
6 changed files with 7 additions and 144 deletions

View File

@ -1,2 +0,0 @@
node_modules
Dockerfile

View File

@ -1,34 +0,0 @@
name: Docker Image CI
on:
push:
branches:
- main
pull_request:
branches:
- main
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v3
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v3
- name: Log in to GitHub Container Registry
uses: docker/login-action@v3
with:
registry: ghcr.io
username: ${{ github.repository_owner }}
password: ${{ secrets.GITHUB_TOKEN }}
- name: Build and push Docker image
uses: docker/build-push-action@v5
with:
context: .
push: true
tags: |
ghcr.io/${{ github.repository_owner }}/abohmeed/getting-started:latest
ghcr.io/${{ github.repository_owner }}/abohmeed/getting-started:${{ github.sha }}

View File

@ -1,7 +0,0 @@
FROM node:18-alpine
WORKDIR /app
COPY . .
RUN yarn install --production && yarn cache clean
ENTRYPOINT [ "node" ]
CMD [ "src/index.js" ]
EXPOSE 3000

100
README.md
View File

@ -1,99 +1,5 @@
# Getting started
# 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](https://docs.docker.com/get-started/) on Docker's official documentation.
The application is based on the tutorial at [docker/getting-started](https://github.com/docker/getting-started).
## Getting Started App with Docker CI/CD
This project demonstrates how to build, test, and deploy a Dockerized application using GitHub Actions for CI/CD.
### How to Fork and Set Up
1. **Fork the repository:**
- Go to the [docker/getting-started-app](https://github.com/docker/getting-started-app) and fork the repository to your GitHub account.
2. **Set the remote URL:**
- After forking, change the remote URL to your repository in the terminal:
```bash
git remote set-url origin https://github.com/abohmeed/getting-started-app.git
```
3. **View the Dockerfile:**
- In the terminal, view the Dockerfile:
```bash
cat Dockerfile
```
### Dockerfile
Heres the `Dockerfile` included in this project:
```dockerfile
FROM node:18-alpine
WORKDIR /app
COPY . .
RUN yarn install --production && yarn cache clean
ENTRYPOINT [ "node" ]
CMD [ "src/index.js" ]
EXPOSE 3000
```
### GitHub Actions CI/CD Workflow
This project includes a GitHub Actions workflow for automatically building and pushing Docker images to the GitHub Container Registry.
#### Workflow File
The `.github/workflows/docker-image.yml` file contains the CI/CD pipeline:
```yaml
name: Docker Image CI
on:
push:
branches:
- main
pull_request:
branches:
- main
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v3
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v3
- name: Log in to GitHub Container Registry
uses: docker/login-action@v3
with:
registry: ghcr.io
username: ${{ github.repository_owner }}
password: ${{ secrets.GITHUB_TOKEN }}
- name: Build and push Docker image
uses: docker/build-push-action@v5
with:
context: .
push: true
tags: |
ghcr.io/${{ github.repository_owner }}/abohmeed/getting-started:latest
ghcr.io/${{ github.repository_owner }}/abohmeed/getting-started:${{ github.sha }}
```
### Workflow Steps:
- **Checkout code:** Fetches the repository content.
- **Set up Docker Buildx:** Prepares Docker Buildx for multi-platform builds.
- **Log in to GitHub Container Registry:** Authenticates the Docker client with GitHubs Container Registry.
- **Build and push:** Builds the Docker image and pushes it to the GitHub Container Registry with two tags: `latest` and the commit SHA.
### Conclusion
This setup allows you to continuously integrate and deploy Docker images to the GitHub Container Registry. Simply push or open a pull request to the `main` branch, and the workflow will handle the rest!
The application is based on the application from the getting started tutorial at https://github.com/docker/getting-started

View File

@ -6,7 +6,7 @@
"scripts": {
"prettify": "prettier -l --write \"**/*.js\"",
"test": "jest",
"dev": "nodemon -L src/index.js"
"dev": "nodemon src/index.js"
},
"dependencies": {
"express": "^4.18.2",

View File

@ -1560,9 +1560,9 @@ html-escaper@^2.0.0:
integrity sha512-H2iMtd0I4Mt5eYiapRdIDjp+XzelXQ0tFE4JS7YFwFevXXMmOp9myNrUvCg0D6ws8iqkRPBfKHgbwig1SmlLfg==
http-cache-semantics@^4.1.0:
version "4.1.0"
resolved "https://registry.yarnpkg.com/http-cache-semantics/-/http-cache-semantics-4.1.0.tgz#49e91c5cbf36c9b94bcfcd71c23d5249ec74e390"
integrity sha512-carPklcUh7ROWRK7Cv27RPtdhYhUsela/ue5/jKzjegVvXDqM2ILE9Q2BGn9JZJh1g87cp56su/FgQSzcWS8cQ==
version "4.1.1"
resolved "https://registry.yarnpkg.com/http-cache-semantics/-/http-cache-semantics-4.1.1.tgz#abe02fcb2985460bf0323be664436ec3476a6d5a"
integrity sha512-er295DKPVsV82j5kw1Gjt+ADA/XYHsajl82cGNQG2eyoPkvgUhX+nDIyelzhIWbbsXP39EHcI6l5tYs2FYqYXQ==
http-errors@2.0.0:
version "2.0.0"