Headless Paystack is an open-source project designed to provide a seamless integration with the Paystack payment gateway. This project allows developers to easily integrate Paystack's payment processing capabilities into their applications without relying on a specific frontend framework.
- Customizable payment page
- Easy integration with Paystack API [coming soon]
- Easier, Secure and reliable payment processing
- Detailed documentation and examples
To install Headless Paystack, follow these steps:
- Clone the repository:
git clone https://github.com/yourusername/headless-paystack.git - Navigate to the project directory:
cd headless-paystack - Install dependencies:
npm install
To deploy Headless Paystack using Docker, follow these steps:
- Rename the
.env.examplefile to.env - Replace the default values with the appropriate values
- Build the Docker image:
docker build -t headless-paystack . - Run the Docker container:
docker run -p 3006:3006 --env-file .env headless-paystack - Connect to your domain
Make sure to create a .env file based on the env.example file provided in the repository. This file should contain all the necessary environment variables required for the application to run.
Make sure to replace 3006 with the appropriate port number if necessary. The application should now be accessible at http://localhost:3006.
To use Headless Paystack in your project :
- Create your paystack account
- Generate payment link by API or by payment page
- Include the payment page url in query parameters, you can include default phone number and callback url like the example below.
- Give this link to your customer, you can use url shortener like bit.ly
Here is an example link to a custom payment page: Payment Page
We welcome contributions from the community! If you would like to contribute, please fork the repository and submit a pull request. For major changes, please open an issue first to discuss what you would like to change.
This project is licensed under the MIT License. See the LICENSE file for more details.
This project includes a scraper to bypass the default Paystack payment page, allowing for a more customized payment experience. Use this feature responsibly and ensure compliance with Paystack's terms of service.
Headless Paystack est un projet open-source conçu pour fournir une intégration transparente avec la passerelle de paiement Paystack. Ce projet permet aux développeurs d'intégrer facilement les capacités de traitement des paiements de Paystack dans leurs applications sans dépendre d'un framework frontend spécifique.
- Page de paiement personnalisable
- Intégration facile avec l'API Paystack [bientôt disponible]
- Traitement des paiements plus facile, sécurisé et fiable
- Documentation détaillée et exemples
Pour installer Headless Paystack, suivez ces étapes :
- Clonez le dépôt :
git clone https://github.com/yourusername/headless-paystack.git - Accédez au répertoire du projet :
cd headless-paystack - Installez les dépendances :
npm install
Pour déployer Headless Paystack en utilisant Docker, suivez ces étapes :
- Renommer le fichier
.env.exampleen.env - Remplacez les valeurs par défaut par les valeurs appropriées
- Construisez l'image Docker :
docker build -t headless-paystack . - Exécutez le conteneur Docker :
docker run -p 3006:3006 --env-file .env headless-paystack - Connectez à votre domaine
Assurez-vous de créer un fichier .env basé sur le fichier env.example fourni dans le dépôt. Ce fichier doit contenir toutes les variables d'environnement nécessaires au fonctionnement de l'application.
Assurez-vous de remplacer 3006 par le numéro de port approprié si nécessaire. L'application devrait maintenant être accessible à http://localhost:3006.
Pour utiliser Headless Paystack dans votre projet:
- Créez votre compte paystack
- Générez le lien de paiement en utilisant l'API ou une page de paiement depuis le tableau de bord
- Incluez l'URL de la page de paiement Paystack dans les paramètres de requête, vous pouvez inclure le numéro de téléphone par défaut comme l'exemple ci-dessous.
- Donnez ce lien à votre client, vous pouvez utiliser un raccourci d'URL comme bit.ly
Voici un exemple de lien vers une page de paiement personnalisée : Page de Paiement
Nous accueillons les contributions de la communauté ! Si vous souhaitez contribuer, veuillez forker le dépôt et soumettre une pull request. Pour les changements majeurs, veuillez ouvrir d'abord une issue pour discuter de ce que vous souhaitez changer.
Ce projet est sous licence MIT. Voir le fichier LICENSE pour plus de détails.
Ce projet inclut un scraper pour contourner la page de paiement par défaut de Paystack, permettant une expérience de paiement plus personnalisée. Utilisez cette fonctionnalité de manière responsable et assurez-vous de respecter les conditions d'utilisation de Paystack.