Skip to content

Backend for a payment system for merchants powered by the Stellar network

License

Notifications You must be signed in to change notification settings

PayStell/paystell-backend

Repository files navigation

PayStell Backend πŸ’«

Backend for a payment system for merchants powered by the Stellar network

PayStell Backend is the server-side component of a payment solution that enables merchants to accept payments on the Stellar network easily and securely. It leverages Stellar blockchain capabilities to offer fast, cost-effective, and reliable transactions.

πŸš€ Features

  • Secure and scalable API for payment processing
  • Real-time transaction monitoring
  • Support for multiple Stellar assets
  • Integration with frontend and admin dashboard
  • Minimal transaction fees
  • Robust data validation and error handling
  • Integration with local and online payment systems

βš™οΈ Project Structure

paystell-backend/
β”œβ”€β”€ src/ # Project source code
β”‚ β”œβ”€β”€ config/ # Project configurations
β”‚ β”œβ”€β”€ controllers/ # Controllers to handle requests
β”‚ β”œβ”€β”€ entities/ # Database entities
β”‚ β”œβ”€β”€ middlewares/ # Middlewares to process requests
β”‚ β”œβ”€β”€ models/ # Data models
β”‚ β”œβ”€β”€ routes/ # API routes
β”‚ β”œβ”€β”€ services/ # Business logic and services
β”‚ β”œβ”€β”€ tests/ # Project tests
β”‚ β”œβ”€β”€ types/ # TypeScript types and interfaces
β”‚ β”œβ”€β”€ utils/ # Utility functions and helpers
β”‚ β”œβ”€β”€ validators/ # Data validators
β”‚ β”œβ”€β”€ app.ts # Application configuration
β”‚ └── index.ts # Application entry point
β”œβ”€β”€ .env # Environment variables
β”œβ”€β”€ .gitignore # File to ignore files in Git
β”œβ”€β”€ jest.config.js # Jest configuration for testing
β”œβ”€β”€ LICENSE # Project license
β”œβ”€β”€ package-lock.json # Dependency version lock
β”œβ”€β”€ package.json # Project metadata and dependencies
└── tsconfig.json # TypeScript configuration

πŸ› οΈ Technologies

  • Backend: Node.js, TypeScript, Express
  • Database: PostgreSQL
  • Testing: Jest
  • API Documentation: Swagger/OpenAPI

🏁 Quick Start

# Clone the repository
git clone https://github.com/PayStell/paystell-backend.git

# Install dependencies
cd paystell-backend
npm install

# Set up environment variables
cp .env.example .env

# Start the development server
npm start

🀝 Contributing

Contributions are welcome! Please read our CONTRIBUTING GUIDE before submitting PRs.

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

πŸ“„ License

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

πŸ’¬ Community

πŸ§‘β€πŸ’» Authors

  • MPSxDev
  • Contributions from the open-source community and OnlyDust

⭐ Support the Project

If you find PayStell Backend useful, please consider:

  • Starring the repository
  • Sharing the project

About

Backend for a payment system for merchants powered by the Stellar network

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages