Skip to content

Reorganize app/ directory layout #319

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

Merged
merged 10 commits into from
Jan 29, 2025
Merged

Reorganize app/ directory layout #319

merged 10 commits into from
Jan 29, 2025

Conversation

katyasoup
Copy link
Collaborator

PULL REQUEST

Summary

overview of new layout:
├── src
│   ├── app
│   │   ├── (pages) - note: parentheses are used to exclude the directory name from the url path
│   │   ├── api/ - import path updates only
│   │   ├── assets/ - not changed
│   │   ├── backend/ - import path updates only
│   │   ├── shared/ - see below
│   │   ├── tests/ - import path updates only
│   │   ├── ui/ - see below
│   │   ├── utils/ - import path updates only
│   │   ├── layout.tsx
│   │   ├── page.tsx
* also includes icon files at app/ level 


next-level contents:
├── src
│   ├── app
│   │   ├── (pages) - components or groups of components that are unique to a single page view/not re-usable
│   │   │   ├── fhir-servers/
│   │   │   ├── query
│   │   │   ├── queryBuilding/
│   │   │   ├── signin/
│   │   │   └── userManagement/
│   │   ├── shared/ - files that are used by both the front and back ends
│   │   │   ├── constants.ts
│   │   │   ├── CustomQuery.ts
│   │   │   ├── database-service.ts
│   │   │   ├── DataProvider.tsx
│   │   │   ├── fhir-servers.ts
│   │   │   ├── format-service.tsx
│   │   │   ├── query-service.ts
│   │   │   ├── seedSqlStructs.ts
│   │   │   └── utils.ts
│   │   ├── ui
│   │   │   ├── components/ - complex groups of elements that are re-usable between pages
│   │   │   ├── designSystem/ - basic elements and simple groups of those elements
│   │   │   └── styles/ - base styles and settings / configs for scss variables, etc. 
│   │   │    * designSystem, component, and page styles should live in their respective directories

Related Issue

Fixes #180 #316 #206

Additional Information

Anything else the review team should know?

Checklist

  • Descriptive Pull Request title
  • Link to relevant issues
  • Provide necessary context for design reviewers
  • Update documentation

@katyasoup katyasoup force-pushed the kcd/components-reorg branch from 1d7f24c to 227ab3e Compare January 27, 2025 23:30
@katyasoup katyasoup marked this pull request as ready for review January 28, 2025 20:29
@katyasoup katyasoup changed the title [WIP] Reorganize app/ directory layout Reorganize app/ directory layout Jan 29, 2025
Copy link
Collaborator

@johanna-skylight johanna-skylight left a comment

Choose a reason for hiding this comment

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

LGTM! with my limited knowledge I tested in local and all look good.

@katyasoup katyasoup merged commit a237146 into main Jan 29, 2025
11 checks passed
@katyasoup katyasoup deleted the kcd/components-reorg branch January 29, 2025 21:45
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.

Reorg frontend file structure
4 participants