Countly / Countly/countly-server
Setup docs drift: docker-compose services not mentioned in README
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 5.9k
- Forks
- 981
- Avg merge
- 18h 51m
- Merged PRs (30d)
- 49
Description
Setup doc drift found
Running a scan that compares docker-compose.yml against README docs to find gaps that break local setup.
Finding — Services not documented docker-compose.yml defines 4 services (countly-api, countly-frontend, mongodb, nginx) but README has no mention of docker compose up. Engineer clones repo, follows docs, app fails to start — nothing is running.
Proposed patch — add to Setup section:
docker compose up -d
Services started: countly-api, countly-frontend, mongodb, nginx
Confidence: HIGH. Happy to open a PR if useful.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the Setup section in README and compare it with the services declared in docker-compose.yml. Add the documented docker compose up -d command and list the four services shown in the issue; verify the resulting instructions cover local startup.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker-compose
- Domain
- devops, documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 68/100