Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add PROJECT_STRUCTURE.md to Document the Repo Structure #4941

Closed
wants to merge 1 commit into from

Conversation

neeru24
Copy link
Contributor

@neeru24 neeru24 commented Nov 10, 2024

This PR introduces a new file, PROJECT_STRUCTURE.md, which provides a comprehensive overview of the folder and file organization within the SwapReads repository. This addition helps current and future contributors easily navigate the project by understanding its structure at a glance.

Changes:

  • Created a new PROJECT_STRUCTURE.md file.
  • Detailed the folder and file structure of both the frontend (client/) and backend (server/) directories.
  • Added descriptions of key files and their respective purposes to guide contributors.

Motivation:

This document will serve as a helpful reference for anyone working on the project, making it easier to find and understand different parts of the codebase. It improves the overall documentation and contributes to a more organized project structure.

fixes: #4937

Kindly merge it with level 3 @abhi03ruchi @sailaja-adapa

Copy link

vercel bot commented Nov 10, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
swapreads ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 10, 2024 9:32am

Copy link
Contributor

Thank you for submitting your pull request! 🙌 We'll review it as soon as possible. In the meantime, please ensure that your changes align with our CONTRIBUTING.md. If there are any specific instructions or feedback regarding your PR, we'll provide them here. Thanks again for your contribution! 😊

Copy link

netlify bot commented Nov 10, 2024

Deploy Preview for swapreadsconnect ready!

Name Link
🔨 Latest commit dda34cf
🔍 Latest deploy log https://app.netlify.com/sites/swapreadsconnect/deploys/67307daa54b4ae00085003f9
😎 Deploy Preview https://deploy-preview-4941--swapreadsconnect.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@abhi03ruchi
Copy link
Collaborator

we already have project structure in readme . chk once

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.

📝 Create PROJECT_STRUCTURE.md to Document Repository Structure
2 participants