ashleylamont / clubpay

ClubPay

⚠️⚠️⚠️ ClubPay is still in the early stages of development and not ready for use. If you're interested in getting involved in the development, join us on our Discord. ⚠️⚠️⚠️

ClubPay is a remix indie stack application designed to replace QPay, allowing clubs to manage and sell memberships via an open-source app.

Table of Contents

• Getting Started
• Development
• Deployment
• Testing
• License

Getting Started

To start working on ClubPay, clone the existing repository and follow the development steps below.

Development

1. Make sure you have installed the necessary dependencies:

npx remix init

2. Perform the initial setup using the setup script:

npm run setup

You may also need to run the following? Idk, it helps me sometimes :/

npx prisma migrate dev --name init

3. Create .env file following the .env.example file

4. Start the development server:

npm run dev

The application should now be accessible at http://localhost:3000.

Deployment

ClubPay includes a set of preconfigured GitHub Actions for deploying to production and staging environments. Before deploying, follow the instructions in the Deployment section in the Remix Indie Stack documentation to set up Fly Apps, GitHub repositories, and secret keys.

Testing

ClubPay (in theory) uses several testing approaches, including: None of these are really configured as yet, but they will be eventually when things are more nailed down.

• End-to-End testing with Cypress
• Unit testing with Vitest and Testing Library
• Static types with TypeScript
• Linting with ESLint
• Code formatting with Prettier

For detailed information on setting up and using these tools, refer to the Testing section in the Remix Indie Stack documentation.

License

ClubPay is licensed under the MIT license.

clubpay's Issues

Users should be able to pay for memberships

Admins should be able to store and edit public club info

Club Admins should be able to upload images directly for club icons and banners

User permissions management

Users should be able to register for memberships of active membership types

Admins should be able to enable local authentication (username/password)

Users should be able to add profile photos

Club admins should be able to create and edit events

Clubs should be able to display public-facing info to logged out users

Club Admins should be able to verify memberships via a QR Code

Users should be able to register to attend events

Users should be able to view memberships via Apple Pay

Club admins should be able to create and manage membership types

Users should be able to link multiple authentication providers to their account

Users should be able to view memberships via Google Wallet

Users should be able to pay to register for events