search

Trisha-tech / OnlineBookSales

This project named Online Book Sales - Backend deals with developing an e-commerce website for Online Book Sale. It provides the user with a catalog of different books available for purchase in the store. In order to facilitate online purchase, a shopping cart is provided to the user.
https://book4u-j5au.onrender.com/
MIT License
139 stars 239 forks source link

[Documentation Update]: Adding a Project Structure Map in README #668

Open siri-chandana-macha opened 2 weeks ago

siri-chandana-macha commented 2 weeks ago

Is there an existing issue for this?

Issue Description

Adding a clear structure map in the documentation to guide contributors on where specific files and folders are located and what they contain.

Suggested Change

For example:

Project Root ├── src/      # Core application files │ ├── components/      # Reusable UI components │ ├── services/      # API calls and business logic │ ├── utils/      # Utility functions │ └── index.js      # Main entry file ├── assets/      # Images, icons, and other static assets ├── config/      # Configuration files (e.g., env variables) └── README.md      # Project overview and instructions

Rationale

This helps new contributors quickly understand the project layout and find files easily.

Urgency

High

Record

github-actions[bot] commented 2 weeks ago

Hi there! Thanks for opening this issue. We appreciate your contribution to this open-source project. We aim to respond or assign your issue as soon as possible.