cc-resource-archive icon indicating copy to clipboard operation
cc-resource-archive copied to clipboard

[Feature] Update README for Local Setup and Live Changes Visibility

Open Dev-JoyA opened this issue 4 months ago • 0 comments

Problem

Description

When following the process of forking, cloning, and running the Docker command for the project, users encounter an issue where any changes made to the code are not reflected in the browser. This limitation hinders the development and testing process, as contributors cannot see real-time updates or modifications they implement in the codebase. As a result, this impacts productivity and the ability to efficiently debug and refine features.

To enhance the development experience, it is essential to provide a clear method for running the project locally, allowing developers to view their changes directly in the browser without relying solely on Docker.

Alternatives

Running Jekyll Directly: Applicants could install Ruby and Jekyll on their local machines to run the project. However, this requires additional setup steps and may lead to permission issues, as experienced during the bundler installation process. This can be aded to the Foundational Technologies page https://opensource.creativecommons.org/contributing-code/foundational-tech/ with detail instruction on how to install and set up .

Additional context

Implementation

  • [ x] I would be interested in implementing this feature.

Dev-JoyA avatar Oct 05 '24 14:10 Dev-JoyA