Skip to content

samsmithyeah/flock

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Flock

Flock is a React Native app designed to help friends coordinate impromptu meetups effortlessly. Built with Expo and Firebase, Flock provides a simple and intuitive interface to make organizing social gatherings easier and more spontaneous.

Features

  • Discover Availability: Quickly check who’s free to hang out.
  • Chat: In-app chat with your friends with dynamically created group chats.
  • Push Notifications: Stay informed when your friends are free or send you a message.
  • Cross-Platform: Runs on both iOS and Android.

Getting Started

Follow these instructions to get Flock up and running on your local machine for development and testing purposes.

Prerequisites

Installation

  1. Clone this repository:

    git clone https://github.com/samsmithyeah/flock.git
    cd flock
  2. Install dependencies:

    npm install
  3. Install expo dev client:

    npx expo install expo-dev-client
  4. Run the application:

    npx expo run:ios

    or:

    npx expo run:android

Firebase Integration

Setup Firebase

  1. Create a Firebase project in the Firebase Console.
  2. Enable the services required for the app:
    • Firestore
    • Authentication (Email/password and Google)
    • Cloud Functions
    • Cloud Messaging (including connection with Apple APNs)
  3. Download the configuration files and put in project root folder:
    • google-services.json (for Android)
    • GoogleService-Info.plist (for iOS)
  4. Update the config in firebase.ts for your firebase account

Deploying Cloud Functions

  1. Navigate to the functions directory:

    cd functions
  2. Install dependencies:

    npm install
  3. Log in to Firebase CLI:

    firebase login
  4. Initialize Firebase Functions (if not already done):

    firebase init functions
    • Select your Firebase project.
    • Choose the language for Cloud Functions (JavaScript or TypeScript).
  5. Deploy functions:

    firebase deploy --only functions

License

This project is licensed under the MIT License. See the LICENSE file for details.

Contact

For any questions or feedback, feel free to reach out to [email protected].

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published