Git Product home page Git Product logo

boothbuddy's Introduction

BoothBuddy

Open Source Love Vue.js Version Nuxt.js Version Appwrite Version Code of Conduct License

BoothBuddy is a progressive web application (PWA) designed to streamline the process of analyzing vendor booths at trade shows and events. Using a combination of OpenAI, Vue.js, TailwindCSS, and Appwrite, it provides a set of tools for booth analysis, including image capture, booth analysis using AI, and detailed reporting.

Purpose

The application aims to empower event participants to gain valuable insights into booth performance, market positioning and vendor information. It provides a user-friendly interface for capturing booth images, analyzing them using AI, and storing the results in a database. The application also provides a dashboard for managing booth data and detailed company information.

Tech Stack

  • Vue.js: A progressive JavaScript framework used for building user interfaces.
  • TailwindCSS: A utility-first CSS framework for rapid UI development.
  • Appwrite: An open-source backend server that simplifies the coding process by providing a set of development tools like Database, Authentication, Cloud Functions, and more.
  • OpenAI: A powerful AI model that can analyze images and provide detailed information about the content.

Getting Started

Prerequisites

  • Node.js (LTS)
  • NPM or Yarn
  • An Appwrite account with a project set up
  • API keys for Appwrite services

Setup

  1. Clone the repository:
git clone https://github.com/yourusername/boothbuddy.git
cd boothbuddy
  1. Install dependencies:
npm install
# or
yarn install
  1. Environment Variables:

Copy the .env.example file to a .env file and fill in the details for your Appwrite project, API keys and prompt for the OpenAI API.

  1. Run the development server:
npm run dev
# or
yarn run dev

Open http://localhost:3000 to view the app in your browser.

Appwrite Services Setup

To get the full functionality of BoothBuddy, you need to set up several services within your Appwrite project:

  • Database: Create collections for storing booth data.
  • Storage: Set up storage for booth images.
  • Functions: Deploy function for image analysis with AI.
  • Authentication: Configure authentication methods for users.

Refer to the official Appwrite documentation for detailed instructions.

Components

  • components/Navbar.vue: Handles navigation and displays user authentication state.
  • components/Footer.vue: Provides application credits and links.
  • pages/dashboard.vue: Main interface for booth management.
  • pages/capture/new.vue: Interface for capturing new booth images.
  • pages/company-details/[id].vue: Displays detailed analysis and company information.
  • services/analyzeImage.js: Function for analyzing images using AI.
  • services/boothService.js: Service for interacting with Appwrite database and storage.
  • stores/boothStore.js: Store for managing booth data.
  • stores/auth.js: Store for managing user authentication.

Code of Conduct

We adhere to a Code of Conduct that we expect project participants to respect. Please read the full text so that you can understand what actions will and will not be tolerated. Adherence to the Code of Conduct ensures all people are welcome to participate in contributing to BoothBuddy.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

boothbuddy's People

Contributors

hummusonrails avatar

Stargazers

0xGolden avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.