soroban-example-dapp icon indicating copy to clipboard operation
soroban-example-dapp copied to clipboard

ODHack: Update Local Deployment with Docker Workflow

Open Julian-dev28 opened this issue 1 year ago • 7 comments

Please add PRs to the update-P21 branch

Description: Update the existing Docker workflow for the Soroban Example Dapp to ensure it is up-to-date, efficient, and easy to use. This includes updating dependencies, improving the Dockerfile, and enhancing the Docker Compose setup.

Tasks:

  1. Review and Update Dockerfile:

    • Review the current workflow in the README
    • Review the current Dockerfile for outdated dependencies and configurations.
    • Update the Dockerfile to use the latest versions of dependencies.
    • Optimize the Dockerfile for better build performance and smaller image size.
  2. Update Docker Compose Configuration:

    • Review the existing docker-compose.yml file.
    • Update service definitions to ensure compatibility with the latest versions.
    • Add any missing services or dependencies that are required for the Dapp.
  3. Improve Documentation:

    • Update the documentation to reflect the changes made to the Dockerfile and Docker Compose configuration.
    • Provide clear instructions on how to build and run the updated Docker containers.
    • Include troubleshooting tips and common issues.
  4. Test Updated Workflow:

    • Thoroughly test the updated Docker workflow on different operating systems.
    • Ensure that the application runs smoothly within the updated Docker containers.
    • Identify and resolve any issues that arise during testing.
  5. Automate Docker Processes:

    • Review existing automation scripts and update them as needed.
    • Ensure that the automation scripts are easy to use and well-documented.
    • Test the automation process to ensure reliability.

Expected Outcome:

  • An updated and optimized Docker workflow for local deployment of the Soroban Example Dapp.
  • Comprehensive and up-to-date documentation on using Docker for local development.
  • Reliable and efficient automation scripts for building and deploying Docker containers.

Why This Is Important: Updating the Docker workflow will ensure that the Soroban Example Dapp remains compatible with the latest dependencies and runs efficiently. This will improve the development experience, making it easier for contributors to set up and work on the project, and ultimately enhance the overall quality of the Dapp.

Julian-dev28 avatar Jul 02 '24 03:07 Julian-dev28

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

Hi @Julian-dev28,

I am Luis Sanchez, a front-end developer with experience in HTML, CSS, React, JavaScript, TypeScript, Docker, and Kubernetes. I am eager to contribute to your project. You can view my technical projects and skills on my Onlydust profile here: https://app.onlydust.com/u/sanieni6. 🥳

Plus, I am a DojoCoding Member!!!

How I plan on tackling this issue

Plan for Updating the Docker Workflow for Soroban Example Dapp:

Review and Update Dockerfile:

Update dependencies and optimize for performance and size. Update Docker Compose Configuration:

Ensure compatibility with latest versions and add missing services. Improve Documentation:

Update instructions, troubleshooting tips, and common issues. Test Updated Workflow:

Test on different operating systems and resolve any issues. Automate Docker Processes:

Update and test automation scripts for reliability. Expected Outcome:

An optimized Docker workflow with updated documentation and reliable automation scripts. Updating the Docker workflow will enhance compatibility and efficiency, improving the development experience and overall quality of the Dapp.

sanieni6 avatar Jul 22 '24 16:07 sanieni6

Hey @sanieni6! Thanks for showing interest. We've created an application for you to contribute to Soroban Example Dapp. Go check it out on OnlyDust!

onlydustapp[bot] avatar Jul 22 '24 16:07 onlydustapp[bot]

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

I live in 2024 as a dev, Docker is the only way I work.

How I plan on tackling this issue

I would try building the available docker image and building the project with it, whichever issues arise, I note and treat it later.

Dedigraz avatar Jul 29 '24 17:07 Dedigraz

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

I'm a backend software engineer with more than 5years of experience. I worked with applications configured with docker.

How I plan on tackling this issue

I would try tu run the current image locally, and then to start to work on the mentioned tasks

jrmncos avatar Jul 30 '24 00:07 jrmncos

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

Hello, my name is Daniel Calderon, I'm a software engineer with over 3 years of experience, I'm also an OSS contributor in OnlyDust(profile: https://app.onlydust.com/u/danielcdz ), and an active member of the Dojo Coding community.

How I plan on tackling this issue

To solve this issue I will do the following:

  • Review the current status of the Dockerfile and the docker-compose to search for improvements and missing dependencies required for the current app.
  • Optimize the Dockerfile for better build performance and smaller image size.
  • I will add any missing dependencies or services on the docker-compose.
  • After improving both files I will build the image to check that everything looks good and run the docker-compose up --build command to ensure the local development is ready.
  • I will test this on Windows and Linux.
  • I will update the automation command.
  • I will update the related docs.

This task can take me about a day.

danielcdz avatar Jul 30 '24 13:07 danielcdz

@Julian-dev28 I'm working on it! thanks for the opportunity

danielcdz avatar Jul 31 '24 19:07 danielcdz

Hello @Julian-dev28 ! qq I don't see any docker-compose.yml file in the protect, should I create it from scratch?

danielcdz avatar Aug 01 '24 00:08 danielcdz