creativecommons / creativecommons/cc-resource-archive
[Feature] Improving Readme.md for Docker compose setup
- Dominant language
- Dockerfile
- Stars
- 66
- Forks
- 137
- PR merge metrics
- No merged PRs in 30d
Description
## 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.
Contributor guide
Assessment
This issue has not been assessed yet.