Skip to content

Organization

Bryan Silva edited this page May 30, 2023 · 3 revisions

Overall File Structure

Here is an overall map of the important files as seen in the project directory

├── app
│   └── App.tsx
│
├── zotmeal-vite
│   └── src
│       └── App.tsx
│
├── shared
│   └── components   <= front end changes here
│       ├── Home.tsx
│       └── ...
│   
├── node_modules
└── package.json

The app folder contains code from the expo package necessary to run the android version of ZotMeal. If there are any issues with the android version that do not appear on web, this is place to go.

Similarly, the zotmeal-vite folder contains code from the vite package to run the web version of ZotMeal.

The shared/components folder contains all the tsx files that modify the app's format. Both the mobile app and vite website refer to the shared components, so modifying the tsx files will affect both (specifically the App.tsx file refers to the components).

Components File Structure

Here is a diagram of the files contained in the shared/assets folder (not up-to date with current main, will change it to this soon)

assets
├── fonts
├── imageAssets
├── lib
│   ├── ColorPalette.tsx
│   └── zotmeal.types.ts
│
└── components
    ├── Home.tsx
    ├── Location.tsx
    ├── location-info
    │   ├── Pricing.tsx
    │   ├── Schedule.tsx
    │   └── Themed-events.tsx
    │
    └── meal-info
        ├── Item.tsx
        ├── ItemNutrition.tsx
        ├── Menu.tsx
        ├── Station.tsx
        └── StationDetails.tsx
Clone this wiki locally