Restructure folder structure

[Coltensiemer]

Here is the updated pull request template with checkboxes:

---

Pull Request: Update README to Contain Project Structure and Review 'lib' Folder Location

GitHub Issue:

• Update README to Contain Project Structure
• Review and Update 'lib' Folder Location

---

Description

This PR addresses the enhancement of the project's documentation and the reorganization of the lib folder.

Objective:

1. Update README to Contain Project Structure:

   • Enhance the comprehensiveness and usability of the project's documentation by updating the README file to include a detailed overview of the project structure.

2. Review and Update 'lib' Folder Location:

   • Review the current location and structure of the lib folder and update its placement and contents to align with best practices and project organization standards.

---

Tasks:

Update README to Contain Project Structure:

1. Introduction:

   • Add a project structure inside the README.

2. Project Structure Overview:

   • Provide a high-level overview of the project's directory structure.
   • Include a tree diagram or list format to display the hierarchy of folders and files.

3. Detailed Explanation:

   • For each major directory, provide a brief description of its purpose and contents.
   • Highlight key files and their roles within the project.
   • Mention any naming conventions or coding standards followed.

Review and Update 'lib' Folder Location:

1. Review Current Structure:

   • Analyze the current location and contents of the lib folder.
   • Identify the purpose of the files and modules contained within it.
   • Assess whether the current structure follows best practices for project organization.

2. Research Best Practices:

   • Investigate industry standards and best practices for organizing library or utility code in a project.
   • Consider different approaches and folder structures commonly used in similar projects.

3. Plan New Structure:

   • Propose a new location and structure for the lib folder that aligns with best practices.
   • Ensure the proposed structure improves clarity and maintainability.
   • Include a detailed plan for relocating and reorganizing the contents of the lib folder.

4. Update Project:

   • Move the lib folder to its new location as per the proposed structure.
   • Update import statements and references throughout the project to reflect the new location.
   • Refactor any code as necessary to adapt to the updated structure.

5. Documentation:

   • Update the README file and any other relevant documentation to reflect the new lib folder structure.
   • Provide a clear explanation of the changes and the reasoning behind them.
   • Include instructions for contributors on where to place new library or utility code.

---

Benefits:

• For README Update:

  • [x] Makes it easier for new contributors to understand and navigate the project.
  • [x] Improves overall documentation quality and completeness.
  • [x] Enhances collaboration by providing clear guidance on project structure and usage.
  • [x] Reduces the learning curve for new developers joining the project.

• For lib Folder Update:

  • [x] Enhances code organization and maintainability.
  • [x] Follows best practices for project structure.
  • [x] Improves clarity and ease of navigation for contributors.
  • [x] Reduces potential for confusion and errors when adding new code.

---

Requirements:

• [x] Familiarity with the project's codebase and structure.
• [x] Understanding of the project's setup and usage instructions.
• [x] Ability to write clear and concise documentation.
• [x] Understanding of best practices for code organization.
• [x] Ability to refactor and test code to ensure functionality is maintained.

---

Acceptance Criteria:

• For README Update:

  • [x] The README file includes a comprehensive introduction, project structure overview, and detailed explanations.
  • [x] Instructions for setting up and using the project are clearly outlined.
  • [x] Contributing guidelines are provided to help new contributors.
  • [x] The documentation is easy to read and understand, with appropriate formatting and examples.

• For lib Folder Update:

  • [x] The lib folder is reviewed and relocated as per the proposed new structure.
  • [x] All import statements and references are updated to reflect the new location.
  • [x] The project builds and runs successfully after the changes.
  • [x] Documentation is updated to reflect the new structure and provide clear guidance for contributors.

---

Additional Information:

• Please provide feedback or suggestions for additional content that could benefit the documentation.
• If there are specific areas of the project structure that require more detail, include them in your comments.
• Ensure that all changes are thoroughly tested to maintain project stability.
• If there are specific concerns or areas that require special attention, include them in your comments.

---

Note: This PR combines the changes for both the README update and the lib folder reorganization to ensure that the documentation and codebase are in sync with the proposed improvements.

---

[vercel[bot]]

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

Name	Status	Preview	Comments	Updated (UTC)
aws-learn	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jul 2, 2024 8:27pm

[Coltensiemer]

@frontendops - During this I did refactor the structure of my components folders to match my app routes and I changed the components/shadcn folder to components/atomic. I performed end 2 end test locally and ran build to make sure everything worked.