Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docker to the local development #29 #30

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Silvia-Wachira
Copy link

Fixes

Description

This PR adds Docker support to simplify local development by creating a consistent environment across different machines and setups. Docker ensures that all dependencies are installed correctly, reducing issues related to version mismatches and environmental differences. This will make the development process smoother and more reliable for all contributors.

Technical details

Tests

Screenshots

screen-capture.webm

Checklist

  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the default branch of the repository (main or master).
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no
    visible errors.

Developer Certificate of Origin

For the purposes of this DCO, "license" is equivalent to "license or public domain dedication," and "open source license" is equivalent to "open content license or public domain dedication."

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@Silvia-Wachira Silvia-Wachira requested a review from a team as a code owner October 5, 2024 07:46
@Silvia-Wachira Silvia-Wachira requested review from TimidRobot and Shafiya-Heena and removed request for a team October 5, 2024 07:46
@Silvia-Wachira
Copy link
Author

@TimidRobot I worked on this issue. Could you give me a review

Copy link
Member

@TimidRobot TimidRobot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please re-reference the related files in https://github.com/creativecommons/cc-resource-archive

@@ -0,0 +1,23 @@
version: '3'
services:
jekyll:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The build section is missing

Comment on lines +27 to +28
# Copy the rest of your site files
COPY . .
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

better to use mounts instead of copying files

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comment on lines +12 to +23
node:
image: node:latest # Use an appropriate Node.js image
volumes:
- ../:/usr/src/app # Mount your project directory
working_dir: /usr/src/app
# command: prettier --write docs/index.html # Adjust the file types as needed

# Add an initialization step to install Prettier before running
# entrypoint: /bin/sh -c "npm install --global prettier && prettier --write docs/index.html"

#multiple files
entrypoint: /bin/sh -c "npm install --global prettier && prettier --write 'docs/**/*.html'"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please remove node service

services:
jekyll:
image: my-jekyll-app:latest
# command: jekyll serve --watch --host 0.0.0.0
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this line can be deleted

Comment on lines +6 to +7
#volumes:
# - .:/srv/jekyll
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

better to use mounts instead of copying files

@TimidRobot TimidRobot self-assigned this Nov 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: In review
Status: In review
Development

Successfully merging this pull request may close these issues.

[Feature] Add docker for easier and more reliable local development
2 participants