Add root README.md and CONTRIBUTING.md

[Abidoyesimze]

This repo has no root README.md and no CONTRIBUTING.md — the only root-level docs are ASSUMPTIONS.md, TODO.md, and PR_DESCRIPTION.md. There is a genuinely thorough docs/ folder (docs/DOCUMENTATION_INDEX.md, docs/DEPLOYMENT.md, etc.), but nothing at the entry point tells a new contributor it exists, or walks them through local setup.

Given the repo actively recruits outside contributors (existing good first issue / bounty-program labels), the lack of an onboarding doc is a real gap.

Task

• Add a root README.md: what the project is, link to docs/DOCUMENTATION_INDEX.md, quickstart (env vars from .env.example, docker-compose.yml, npm run dev).
• Add CONTRIBUTING.md: local setup, npm test / npm run lint / npm run typecheck, PR conventions (see docs/PR_GIT_HOOKS.md and .husky/), how issues map to PRs.

Good first issue.

[Michael-Olagoke]

@Michael-Olagoke has applied to work on this issue as part of the Stellar Wave Program's 8th wave.

kindly assign this issue to me

ℹ️ Repo Maintainers: To accept this application, review their application or assign @Michael-Olagoke to this issue.

[Demilade10]

@Demilade10 has applied to work on this issue as part of the Stellar Wave Program's 8th wave.

Hi I can fix this

ℹ️ Repo Maintainers: To accept this application, review their application or assign @Demilade10 to this issue.

[pimaster900]

@pimaster900 has applied to work on this issue as part of the Stellar Wave Program's 8th wave.

I would like to work on this issue.

ℹ️ Repo Maintainers: To accept this application, review their application or assign @pimaster900 to this issue.

[Risktaker001]

@Risktaker001 has applied to work on this issue as part of the Stellar Wave Program's 8th wave.

Hi, I'd like to work on this issue. I understand the requirements and can implement the proposed changes while keeping the existing functionality intact. I'll also add the necessary tests, handle relevant edge cases, and verify that the project builds and all tests pass successfully.

ℹ️ Repo Maintainers: To accept this application, review their application or assign @Risktaker001 to this issue.

[SOLODAM]

@SOLODAM has applied to work on this issue as part of the Stellar Wave Program's 8th wave.

Hi, i can fix this.

ℹ️ Repo Maintainers: To accept this application, review their application or assign @SOLODAM to this issue.

[Peaostrel]

@Peaostrel has applied to work on this issue as part of the Stellar Wave Program's 8th wave.

i can handle this quickly

ℹ️ Repo Maintainers: To accept this application, review their application or assign @Peaostrel to this issue.

[dorismaduegbunam]

@dorismaduegbunam has applied to work on this issue as part of the Stellar Wave Program's 8th wave.

Gm Chief, I would love to take on this issue. I'm a software engineer with over four years experience and i'm confident I can resolve this issue

ℹ️ Repo Maintainers: To accept this application, review their application or assign @dorismaduegbunam to this issue.

[drips-wave]

Congratulations, @dorismaduegbunam! 🎉 Your application was accepted by the repo's maintainers, and the issue is due on August 31, 2026.

🧑‍💻 @dorismaduegbunam: Please resolve the issue such that the repo's maintainers have enough time to review your contribution before the due date. You'll earn Points for completing the issue on-time, which will make you eligible for a share of the Stellar Wave Program's reward pool.

Warning

When opening a PR, please link it to this issue to ensure it gets tracked accurately. Points are awarded when this issue is marked as completed by the maintainer.

🤠 Repo maintainers: Please keep an eye on the contributor's progress and review their work before the due date. You can manage this issue, including adjusting its complexity and points, here.

🌊 Happy Wave 🌊