Habits Together

A mobile app where you can track habits together with friends
Waitlist Signup: habitstogether.app

Table of Contents

1. About The Project
   • Demo
   • Key Features
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Contributing
4. License
5. Contact
6. Acknowledgments

About The Project

Demo

demo.mp4

Key Features

• Habits Tracking: Track customizable habits with the click of a button.
• Social Features: Add friends, participate in habits together, and keep each other on track.
• Notifications: Get reminders to complete your habits and nudge your friends to complete theirs.

Built With

• React Native
• Firebase

Noteworthy Libraries Used

• Expo
• Expo Router
• Nativewind
• React Native MMKV
• React Native Safe Area Context
• React Query
• Zod
• Zustand

Getting Started

Prerequisites

• pnpm
• iOS simulator or Android emulator
  • See Expo documentation on setting up a development environment

Installation

1. Clone the repo
2. Install packages

   pnpm install
   

3. Prebuild

   pnpm prebuild
   

4. Run the app

   pnpm start
   

   Then instructions will appear for how to open your simulator/emulator. Alternatively, you can use pnpm ios or pnpm android directly. (You might need to use pnpm ios or pnpm android after installing packages for the first time.)

Common Issues

• If some nativewind styles are just not applying sometimes, clear the cache using pnpm start -c.

Firestore Schema

// habits collection
{
  [habitId: HabitIdT]: {
    title: string;
    icon: string;
    description: string | undefined;
    colorName: string;
    settings: {
      allowMultipleCompletions: boolean;
    };
    createdAt: Date;
    participants: { // map, not subcollection
      [userId: UserIdT]: {
        displayName: string;
        username: string;
        lastActivity: Date;
        isOwner: boolean | undefined;
      };
    };
    // subcollection
    participantCompletions: {
      [userId: UserIdT]: {
        entries: {
          [entryId: EntryIdT]: {
            numberOfCompletions: number;
            note: string | undefined;
            image: string | undefined;
          };
        };
      };
    };
  };
}

// users collection
{
  [userId: UserIdT]: {
    username: string;
    displayName: string;
    createdAt: Date;
  };
}

// relationships collection
{
  [userId: UserIdT]: {
    [otherUserId: UserIdT]: {
      {
        status: "friends" | "pending" | "blocked";
        friendsSince: Date | undefined;
      };
    };
  };
}

// notifications collection
{
  [notificationId: NotificationIdT]: {
    type: "habitInvite" | "nudge" | "friendRequest";
    senderId: UserIdT;
    receiverId: UserIdT;
    habitId: HabitIdT | undefined;
    sentAt: Date;
  };
}

Contributing

We are open to contributions. You can fork the repository then make a pull request. But it would be best to reach out first!

License

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

Contact

For any inquiries, contact [email protected].

Acknowledgments

• Used React Native Template Obytes as a starter
• Part of Buildspace s5