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

Refactor/refactor project structure #70

Merged

Conversation

tyin363
Copy link
Contributor

@tyin363 tyin363 commented Oct 4, 2024

Context

This PR addresses the need to optimize the project structure by removing unnecessary files from version control, renaming folders for consistency, and organizing styles into a dedicated folder. These changes improve maintainability and follow best practices in file structure and project organization.

Closes #69

What Changed?

  • Removed node_modules from the repository and added it to .gitignore.
  • Renamed the Backend folder to backend to follow lowercase naming conventions.
  • Moved all scattered CSS files into a central styles/ folder.
  • Updated all import paths in JavaScript files to point to the new CSS file locations in styles/.

How To Review

  1. Start by reviewing the changes in .gitignore to ensure the proper exclusion of node_modules.
  2. Check the folder renaming from Backend to backend.
  3. Review the styles/ folder to confirm that all CSS files were moved there.
  4. Verify that all CSS imports in relevant components and pages have been updated correctly.
  5. Check for any unnecessary files or changes.

Testing

  • After the refactor, tested the project to ensure all components and pages are working as expected with the updated CSS imports.
  • Verified that no styles are broken and all functionality remains intact.
  • Confirmed that no node_modules files are committed and everything rebuilds correctly after running npm install.

Risks

  • Import path issues: The main risk lies in missing or incorrect paths when updating the CSS imports. Focus on verifying that all paths to the CSS files are correct in the JS files.
  • Folder renaming issues: Some operating systems may have issues with renaming folders where only the casing changes (e.g., Backend to backend), so double-check to ensure the folder is renamed correctly without conflicts.

Notes

  • Be sure to reinstall dependencies locally with npm install after the node_modules removal.
  • Thorough testing has been done to ensure the refactor does not introduce style or functionality issues.

Copy link
Contributor

@today0-o today0-o left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've checked the branch and confirmed that every file is relocated and refactored corretly. I'm sure that this will contribute to the tidinness of the project and will be a great help for contributors who will later access our files! LGTM to merge. Thanks for your work!

@today0-o today0-o merged commit 7d720a2 into SOFTENG310-G5:main Oct 5, 2024
7 checks passed
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.

[REFACTOR] Project Structure Optimization and Dependency Cleanup
2 participants