📋 Table of Contents

1. ✨ Introduction
2. ✅ Tech Stack
3. 🕹️ Features
4. 🤸 Quick Start
5. 📱 Snippets
6. 🧑‍🚀 Contributors

✨ Introduction

Locally is a full-stack mobile app that connects users with personalized local experiences, helping them discover events, restaurants, landmarks, and activities tailored to their interests. Ideal for travelers, newcomers, or locals seeking new adventures, the app provides real-time updates, community-driven insights, and interactive features like reviews and Q&A to make informed decisions. By promoting local culture and supporting small businesses, Locally fosters community connections, celebrates heritage, and contributes to the local economy.

ProjectBoard

✅ Tech Stack

• React Native
• Expo
• Nativewind
• Firebase
• Zustand
• Stripe
• Google Maps

🕹️ Features

Main Features

👉 Fetch events by location - Discover events happening nearby.

👉 Filter events by reference - Find events tailored to users' interests.

👉 Purchase/manage tickets - Easily secure and track obtaining event tickets.

👉 Bookmark events - Save your favorite events for quick access.

👉 Send messages to events - Connect directly with event organizers and participants.

👉 Send messages to users - Engage with other users.

👉 Follow users - Keep up with their favorite people’s activities.

👉 Get notifications of new events - Stay updated with the latest events from their followers.

👉 Subscribe to host events - Empower event management journey with ease.

👉 Create new events - Bring events to life and share them with others.

Additional Features (Future Implementation)

🤞 Event analytics - Track and analyze event performance and attendee engagement

🤞 Share a post about an event - Allow users to share their experience about events they attend.

🤞 Provide event template and customization - Easily create and personalize events with templates.

🤞 Edit event - Make changes to your event details at any time.

🤞 Allow booking specific date/time - Enable users to select their preferred event date and time.

🤞 Request details for purchasing tickets - Collect necessary information for ticket bookings.

🤞 Share/Invite other users - Invite friends and followers to join an event.

🤞 Email ticket and add to digital wallet - Send tickets via email or add them directly to the digital wallet.

🤞 Sign-in with other credentials - Allow users to sign in using multiple authentication methods.

🤸 Quick Start

Follow these steps to set up the project locally on your machine.

Prerequisites

Make sure you have the following installed on your machine:

• Git
• Node.js
• npm (Node Package Manager)

Installation Instructions

Cloning the Repository

git clone https://github.com/cis3296f24/Locally.git
cd locally-app

Installation

Install the project dependencies using npm:

npm install

Installs the Expo CLI globally:

npm install -g expo-cli

Set Up Environment Variables

Create a new file named .env in the root of your project and add the following content:

GOOGLE_API_KEY=

STRIPE_PUBLISHABLE_KEY=

STRIPE_SECRET_KEY=

EXPO_PUBLIC_SERVER_URL=https://locally.com/

Find the provided testing API keys here (TU credential access only).

Running the Project

npx expo start

Run the App on Your Device

Download the Expo Go app and Scan the QR code on your respective device to view the project.

Option 1: Use Expo Go on Mobile

1. Install Expo Go on your mobile device.
2. Ensure your device is on the same Wi-Fi network as the network on the development server.
3. Open Expo Go, and scan the QR code generated in the terminal to load the app on your device.
4. Expo Sign-up is necessary to register your device to receive notifications.

Option 2: Use an Emulator or Simulator

• Android Emulator:
  • Open Android Studio and launch an emulator.
  • In the terminal, press a to open the app on Android.
• iOS Simulator (macOS only):
  • Open Xcode and launch an iOS simulator.
  • In the terminal, press i to open the app on iOS.

📱 Snippets

🧑‍🚀 Contributors