R-Fitness Gym Check-in System

A web application for managing gym member check-ins, built with Remix, Prisma, and Square API.

Features

• Member check-in via phone number
• Square API integration for membership verification
• Admin dashboard with real-time check-in notifications
• Real-time webhook processing for Square events
• Check-in history and analytics
• PostgreSQL database for data persistence
• Docker support for development and production

Tech Stack

• Frontend: React, Remix, TailwindCSS
• Backend: Node.js, Remix
• Database: PostgreSQL with Prisma ORM
• API Integration: Square API for membership verification
• Real-time Updates: Server-Sent Events (SSE)
• Deployment: Docker, Docker Swarm

Getting Started

Prerequisites

• Node.js 20+
• Docker and Docker Compose (for development with database)
• Square Developer Account (for API access)

Installation

1. Clone the repository:

   git clone https://github.com/yourusername/rfitness.git
   cd rfitness

2. Install dependencies:

   npm install

3. Set up environment variables:

   cp .env.example .env

   Edit the .env file with your Square API credentials and database connection string.

4. Add your static assets:

   • Place your logo in public/logo-light.png
   • Place your QR code image in public/gym-checkin-qr.png

5. Start the development database:

   docker-compose -f compose.dev.yaml up -d

6. Run database migrations:

   npx prisma migrate dev

7. Start the development server:

   npm run dev

Database Implementation

The application uses PostgreSQL with Prisma ORM for data persistence. The database schema includes:

• User: Staff and admin users
• Customer: Gym members with membership information
• CheckIn: Records of member check-ins
• Configuration: System configuration settings
• SystemLog: System activity and error logs

For detailed information about the database implementation, see the Database Implementation Guide.

Real-time Features

The application includes several real-time features:

• Check-in Notifications: Instant notifications on the admin dashboard when members check in
• Square Webhook Integration: Real-time updates when customer or subscription data changes in Square
• Dashboard Refresh: Automatic data refresh when webhook events are received

These features use Server-Sent Events (SSE) to provide a responsive user experience without requiring page refreshes.

Static Assets

The application uses the following static assets:

• Logo: public/logo-light.png - Used on the check-in screen
• QR Code: public/gym-checkin-qr.png - Used for member check-ins

To customize these assets, simply replace the files in the public directory with your own versions.

Production Deployment

For production deployment instructions, see the Deployment Guide.

Environment-Specific Behavior

The application behaves differently based on the environment:

Development Environment

• Uses mock data when Square API is not configured
• Still stores check-ins and customer data in the database for testing
• Logs system events to both memory and database

Production Environment

• Uses real data from Square API
• Stores all check-ins and customer data in the database
• Logs all system events to the database for monitoring
• Processes Square webhooks in real-time

Contributing

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

License

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