Skip to content

Write comprehensive README #15

Description

@mrsumanbiswas

Create a detailed README.md that includes:

  • Project name, logo, and one‑line description
  • Tech stack overview (Go, Flutter, PostgreSQL, …)
  • Local development setup (clone, Docker, environment variables, run server & app)
  • Link to full API documentation (docs/api-spec.md)
  • Contribution guide (branch naming, commit style, PR process)
  • Badges (build status, license, version)

This is the first thing new contributors and testers will see. Make it clear and welcoming.

Metadata

Metadata

Labels

documentationImprovements or additions to documentationgood first issueGood for newcomers

Type

Fields

No fields configured for Task.

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions