An open API service indexing awesome lists of open source software.

https://github.com/muhammad-fiaz/payfolio

Payfolio is a self-hosted Payment web application designed to make it easy for users to support creators by making small contributions.
https://github.com/muhammad-fiaz/payfolio

nextjs nextjs-example nextjs-production-template nextjs-project nextjs-template nextjs-typescript nextjs15 payment-gateway payment-integration payments razorpay razorpay-integration razorpay-payment-gateway react reactjs self-hosted self-hosted-pay

Last synced: 2 months ago
JSON representation

Payfolio is a self-hosted Payment web application designed to make it easy for users to support creators by making small contributions.

Awesome Lists containing this project

README

          


Preview

Payfolio

[![GitHub last commit](https://img.shields.io/github/last-commit/muhammad-fiaz/payfolio)](https://github.com/muhammad-fiaz/payfolio/commits/main)
[![GitHub license](https://img.shields.io/github/license/muhammad-fiaz/payfolio)](LICENSE)
[![GitHub issues](https://img.shields.io/github/issues/muhammad-fiaz/payfolio)](https://github.com/muhammad-fiaz/payfolio/issues)
[![GitHub pull requests](https://img.shields.io/github/issues-pr/muhammad-fiaz/payfolio)](https://github.com/muhammad-fiaz/payfolio/pulls)
[![GitHub contributors](https://img.shields.io/github/contributors/muhammad-fiaz/payfolio)](https://github.com/muhammad-fiaz/payfolio/graphs/contributors)
[![GitHub maintainer](https://img.shields.io/badge/maintainer-Muhammad%20Fiaz-blue)](https://github.com/muhammad-fiaz)
[![GitHub repo size](https://img.shields.io/github/repo-size/muhammad-fiaz/payfolio)](https://github.com/muhammad-fiaz/payfolio)
[![GitHub code size](https://img.shields.io/github/languages/code-size/muhammad-fiaz/payfolio)](https://github.com/muhammad-fiaz/payfolio)
[![GitHub forks](https://img.shields.io/github/forks/muhammad-fiaz/payfolio?style=social)](https://github.com/muhammad-fiaz/payfolio/network/members)
[![GitHub stars](https://img.shields.io/github/stars/muhammad-fiaz/payfolio?style=social)](https://github.com/muhammad-fiaz/payfolio/stargazers)
[![GitHub watchers](https://img.shields.io/github/watchers/muhammad-fiaz/payfolio?style=social)](https://github.com/muhammad-fiaz/payfolio/watchers)
[![GitHub open issues](https://img.shields.io/github/issues/muhammad-fiaz/payfolio)](https://github.com/muhammad-fiaz/payfolio/issues)
[![GitHub closed issues](https://img.shields.io/github/issues-closed/muhammad-fiaz/payfolio)](https://github.com/muhammad-fiaz/payfolio/issues?q=is%3Aissue+is%3Aclosed)
[![GitHub discussions](https://img.shields.io/github/discussions/muhammad-fiaz/payfolio)](https://github.com/muhammad-fiaz/payfolio/discussions)
[![GitHub language count](https://img.shields.io/github/languages/count/muhammad-fiaz/payfolio)](https://github.com/muhammad-fiaz/payfolio)
[![GitHub top language](https://img.shields.io/github/languages/top/muhammad-fiaz/payfolio)](https://github.com/muhammad-fiaz/payfolio)

Payfolio is a self-hosted payment application that serves as an alternative to Patreon, Ko-fi, and Buy Me a Coffee. It enables users to support creators by making small contributions. The platform allows users to choose the number of coffees they want to buy, enter their name and a message (both optional), specify the amount, and donate.

## Features

- Easy-to-use interface for making donations.
- Responsive design for a seamless experience on all devices.
- Dark mode support.
- Secure and fast transactions.
- Customizable donation options.
- Integration with Razorpay for handling payments.

## Technologies Used

- Next.js (React framework)
- Tailwind CSS
- TypeScript
- Node.js
- Razorpay (for payments)

## Getting Started

Follow these instructions to get a copy of the project up and running on your local machine for development and testing.

### Prerequisites

- Node.js (v18 or higher)
- npm (v6 or higher) or yarn (v1.22 or higher)

### Installation

1. Clone the repository:

```bash
git clone https://github.com/muhammad-fiaz/payfolio.git
```

2. Navigate to the project directory:

```bash
cd payfolio
```

3. Install the dependencies:

```bash
npm install
# or
yarn install
# or
pnpm install
# or
bun install
```

### Running the Application

To start the development server, run:

```bash
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev
```

The application will be available at `http://localhost:3000`.

### Building for Production

To build the application for production, run:

```bash
npm run build
# or
yarn build
# or
pnpm build
# or
bun build
```

This will generate an optimized production build.

### Deployment

You can deploy the application to platforms that support Next.js, such as:

- Vercel
- Netlify
- Railway
- DigitalOcean
- AWS, etc.

## Payment Gateway

Payfolio uses Razorpay to handle payments securely. You will need to set up a Razorpay account and obtain the API keys to integrate it with Payfolio. Follow the Razorpay documentation for detailed instructions on setting up your account and obtaining the necessary credentials.

## Contributing

Contributions are welcome! Please read the [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct and the process for submitting pull requests.

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.