Food Truck Mapper

Discover Delicious Adventures on Wheels!
Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Project Structure
4. License

About the Project

Food Truck Mapper is an innovative, full-stack solution developed as part of a university assignment, designed to revolutionize the way food enthusiasts discover and interact with local food trucks. The platform consists of:

• A mobile app for users to locate food trucks, explore menus, and access real-time information.
• An admin dashboard for system administrators to manage food truck data and maintain platform integrity.
• A server providing RESTful APIs, connecting all components and handling core business logic.
• A robust database system for secure data storage and real-time synchronization.

(back to top)

Built With

Category	Tech
Mobile	React Native, Expo
Admin-Web	Vite, React, TailwindCSS, ShadCN, TanStack Router, TanStack Query, TanStack Table
Server	ElysiaJS with Swagger
Database	DrizzleORM, PostgreSQL
Package Manager	Bun

Additionally, this project is managed with Turborepo, which helps to run scripts and manage dependencies across multiple packages efficiently.

(back to top)

Getting Started

To get a local copy up and running, follow these steps:

Prerequisites

• Ensure you have Bun installed on your system.

Installation

1. Clone the repository:

   git clone https://github.com/Kyziq/food-truck-mapper.git

2. Navigate to the project directory:

   cd food-truck-mapper

3. Install dependencies:

   bun install

4. Set up the environment:

   Before proceeding, make sure to set up your environment variables. Copy the example environment file at root and rename it to .env.

   cp .env.example .env

5. Edit the .env file and update the variables with to match your actual credentials.

    DB_URL="postgres://your_username:[email protected]:5432/food_truck_mapper"
    GOOGLE_MAPS_API_KEY="your_google_maps_api_key_here"
    API_BASE_URL="http://your_api_base_url_here:your_server_port"

6. Start the development environment:

   This command will concurrently start the development servers for mobile app, admin dashboard, and server as defined in the Turborepo configuration.

   bun dev

(back to top)

Project Structure

root
├─ apps
│  ├─ admin-web
│  │  ├─ src
│  ├─ mobile
│  │  ├─ assets
│  │  ├─ src
│  └─ server
│     ├─ src
├─ packages
│  ├─ assets
│  ├─ database
├─ .env
├─ .env.example
├─ .gitignore
├─ LICENSE
├─ README.md
├─ bun.lockb
├─ package.json
└─ turbo.json

For detailed information on each application, please refer to their respective README files:

• Mobile: /apps/mobile/README.md
• Admin Dashboard: /apps/admin-web/README.md
• Server: /apps/server/README.md
• Database: /packages/database/README.md

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)