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

Update project directory structure #138

Open
ezra-sg opened this issue Sep 10, 2022 · 0 comments
Open

Update project directory structure #138

ezra-sg opened this issue Sep 10, 2022 · 0 comments
Labels
🔬 Needs Refinement Further information is required 🔧 Tech Debt Refactoring, library upgrades, documentation

Comments

@ezra-sg
Copy link
Contributor

ezra-sg commented Sep 10, 2022

Overview

As the project grows, it becomes more important for the directory structures to be well-ordered and follow an explicit convention.

Acceptance criteria

  • webpack aliases should begin with ~ to make imports easier to read (imports currently look like top level directories)
  • devise directory structure, including:
    • routes/
    • modules/
    • styles/
    • test/
    • documentation/
    • images/
  • each subdir should follow a predefined pattern, eg. for modules and routes
    • components/ for SFCs
    • js/ for utils and store

Technical considerations

N/A

Tasks

@ezra-sg ezra-sg added the 🔧 Tech Debt Refactoring, library upgrades, documentation label Sep 10, 2022
@ezra-sg ezra-sg added the 🔬 Needs Refinement Further information is required label Oct 9, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🔬 Needs Refinement Further information is required 🔧 Tech Debt Refactoring, library upgrades, documentation
Projects
None yet
Development

No branches or pull requests

1 participant