Skip to content

Commit

Permalink
chore(docs): update README
Browse files Browse the repository at this point in the history
  • Loading branch information
mgramigna committed Dec 23, 2023
1 parent b9e2671 commit 9319da3
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,37 @@ Made with:
3. Run `pnpm dev` from the root
4. Open the Expo Go app to load the React Native application on your device

### Navigating the Codebase

```
.
├── apps
│   ├── expo
│   │   └── src
│   │   ├── app --> app routes using expo-router
│   │   ├── components --> React components used throughout the app
│   │   ├── fhirpath --> fhirpath helpers for extracting strings from FHIR resources
│   │   ├── theme --> Color palette used from tailwind config
│   │   └── ...
│   └── nextjs --> Nextjs serverless API handlers
├── packages
│   ├── api
│   │   └── src
│   │   ├── router --> tRPC routers for each FHIR resource
│   │   └── ...
│   └── canvas
│   └── src
│   ├── models --> Zod Schemas/TypeScript types for each FHIR Resource
│   ├── services --> Services for each FHIR resource
│   └── ...
└── tooling
├── eslint --> Shared eslint config
├── github --> GitHub actions/CI utils
├── prettier --> Shared prettier config
├── tailwind --> Shared tailwind config
└── typescript --> Shared TypeScript config
```

### Testing

1. Run the model transformation unit tests with `pnpm -F canvas test`
Expand Down

0 comments on commit 9319da3

Please sign in to comment.