Organization

Overall File Structure

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

├── app
├── zotmeal-vite
├── shared
├── backend
│
└── node_modules

Development Folders

The two main folders in which files will be modified in are the shared and backend folders.

The shared folder contains all files that are shared between the website and app front end. This includes things like image assets, fonts, and React components.

The backend folder contains all files used for the ZotMeal API. This includes the .js containing netlify functions.

Other Folders

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.

For those not familar with Node.js, the node_modules folder contains all files for the packages used on ZotMeal (includes React, React-Native, and Vite). This file is purely a local file that does not exist in the git repository.

Frontend 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
    └── meal-info