Skip to content

Docs: Improve README Local Development Setup Instructions#10

Open
sruthichinnannan wants to merge 12 commits into223MapAction:mainfrom
sruthichinnannan:docs/improve-setup-readme
Open

Docs: Improve README Local Development Setup Instructions#10
sruthichinnannan wants to merge 12 commits into223MapAction:mainfrom
sruthichinnannan:docs/improve-setup-readme

Conversation

@sruthichinnannan
Copy link

This PR addresses #1 by updating the README.md to provide clearer and more accurate instructions for setting up the local development environment.

Key changes include:

  • Detailed prerequisites.
  • Clear instructions for cloning and configuring the .env file.
  • Accurate commands based on _cd_pipeline.yml (using api-server, accessing via http://localhost, automatic migrations).
  • Addition of a recommended "Verify Your Setup" section.
  • Clarification on running management commands via docker-compose exec.
  • Improved formatting and structure for better readability.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants