Skip to content

Frontend: Improve README structure #77

@Ayush8923

Description

@Ayush8923

Is your feature request related to a problem?
The current frontend README is poorly structured and lacks clear, step-by-step setup instructions. This complicates onboarding for new developers and creates confusion regarding the development workflow.

Describe the solution you'd like
Restructure and clean up the README with an organized format, including a Table of Contents and essential sections such as:

  • 📋 Table of Contents
  • Pre-requisite
  • Software Dependencies
  • npm (via asdf)
  • Kaapi Backend
  • Clone Frontend Repo
  • Git commands to clone
  • Installation
  • Start backend server
  • Start frontend server
  • Available Scripts
  • Localization
  • Deploying Release on EC2 with CD
  • Learn More

Each section should have clear explanations and step-by-step instructions where needed.

Original issue

Describe the current behavior
The current frontend README is not well-structured and lacks clear, step-by-step instructions for setup, development, and deployment. Some important sections are missing or not properly organized, which makes onboarding difficult for new developers and creates confusion around the development workflow.

Describe the enhancement you'd like
The README should be cleaned up and restructured with a clear and organized format. It should include a proper Table of Contents and cover all essential sections such as:

📋 Table of Contents  
Pre-requisite  
Software Dependencies  
npm (via asdf)  
Kaapi Backend  
Clone Frontend Repo  
Git commands to clone  
Installation  
Start backend server  
Start frontend server  
Available Scripts  
Localization  
Deploying Release on EC2 with CD  
Learn More  

Each section should have clear explanations and step-by-step instructions where necessary.

Why is this enhancement needed?
• Improves onboarding experience
• Provides a single source of truth for setup and workflows
• Reduces confusion and setup errors
• Enhances maintainability and consistency in documentation
• Helps standardize development and deployment processes

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationenhancementNew feature or request

Type

No type

Projects

Status

Closed

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions