cc-resource-archive [Feature] Improving Readme.md for Docker compose setup

Problem

The Docker Compose setup doesn't consist of all the steps in brief that one should do to set up a local working environment

Description

The steps present in the Readme for setting up a local development environment by forking and cloning the repository are incomplete. If one wants to setup an environment using a Command prompt or using VS Code integrated terminal or a Git bash client, these steps are not mentioned in the Readme.md file. I have correctly set up the local development environment and I had to go to the Internet to search for a few steps involved. Using this experience, I want to improve the documentation to contribute and help my fellow developers working on CC Resource Archive project.

Alternatives

Adding images to describe various steps can help a lot. I can use Scribe (https://scribehow.com/) to properly document the steps and create a step-by-step guide.

Implementation

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

Mar 29 '23 06:03 Shivangbhatnagar237

@Shivangbhatnagar237 this issue is quite similar to #125. If you have something different to add, You can leave it as a comment over there.

Mar 29 '23 11:03 Lakshay-Pruthi

@Lakshay-Pruthi Agreed. @Shivangbhatnagar237 you can carry the conversation here #125.

Mar 29 '23 13:03 Xaid-vfx

Sure, I've added the whole issue template to #125's comment.

Mar 29 '23 19:03 Shivangbhatnagar237

@TimidRobot Actually I opened this issue, but @Lakshay-Pruthi and @Xaid-vfx told me to add the issue in the comments of #125

Mar 31 '23 21:03 Shivangbhatnagar237

Hey @possumbilities, the suggestions for the amendments in the Readme include:

Adding complete steps informing what will happen (Install Docker and after installing, it will reboot your device)
Adding information (It requires Windows subsystem for linux, or wsl enabled and upgraded to the latest version)
Adding supporting info that might be required like wsl can be upgraded by the command wsl --update in Windows Powershell

Apr 01 '23 21:04 Shivangbhatnagar237

Hey @possumbilities, changing the Readme file may help new contributors, are my suggestions for amendments all correct?

Apr 03 '23 21:04 Shivangbhatnagar237

Hey @possumbilities, what are your views on this?

Apr 07 '23 12:04 Shivangbhatnagar237

I believe, while the original Issue here is a bit off scope, the comment further in here merits consideration, to further clarify the documentation.:

Hey @possumbilities, the suggestions for the amendments in the Readme include:

Adding complete steps informing what will happen (Install Docker and after installing, it will reboot your device)

Adding information (It requires Windows subsystem for linux, or wsl enabled and upgraded to the latest version)

Adding supporting info that might be required like wsl can be upgraded by the command wsl --update in Windows Powershell

Aug 20 '24 16:08 possumbilities

Hey, so can I work on this issue?

I believe, while the original Issue here is a bit off scope, the comment further in here merits consideration, to further clarify the documentation.:

Hey @possumbilities, the suggestions for the amendments in the Readme include:

Adding complete steps informing what will happen (Install Docker and after installing, it will reboot your device)

Adding information (It requires Windows subsystem for linux, or wsl enabled and upgraded to the latest version)

Adding supporting info that might be required like wsl can be upgraded by the command wsl --update in Windows Powershell

Oct 06 '24 17:10 Shivangbhatnagar237