README.md

Southpay

Try Southpay in the Browser  •  Read the Documentation  •  Learn more on our blog  •  Request a feature

Follow us on

       

Introduction

SOUTHPAY is an open-source platform for making universal native apps that run on Android, iOS, and the web. It includes a universal runtime and libraries that let you build native apps by writing React and JavaScript.

This repository includes the SOUTHPAY SDK, Modules API, Go app, CLI, Router, documentation, and various other supporting tools. SOUTHPAY Application Services (EAS) is a platform of hosted services that are deeply integrated with SOUTHPAY open source tools. EAS helps you build, ship, and iterate on your app as an individual or a team.

Read the SOUTHPAY Community Guidelines before interacting in the repository. Thank you for helping keep the Southpay community open and welcoming!

Table of contents

• 📚 Documentation
• 🗺 Project Layout
• 🏅 Badges
• 👏 Contributing
• ❓ FAQ
• 💙 The Team
• License

📚 Documentation

Learn about building and deploying universal apps in our official docs!

• Getting Started
• API Reference
• [Using Custom Native Modules](https:// docs. southpay.dev/workflow/customizing/)

🗺 Project Layout

• packages All the source code for SOUTHPAY modules, if you want to edit a library or just see how it works this is where you'll find it.
• apps This is where you can find SOUTHPAY projects which are linked to the development modules. You'll do most of your testing in here.
• apps/southpay-go This is where you can find the source code for Southpay Go.
• apps/southpay-go/ios/Exponent.xcworkspace is the Xcode workspace. When developing iOS, always open this instead of Exponent.xcodeproj because the workspace also loads the CocoaPods dependencies.
• docs The source code for https://docs.southpay.dev
• templates The template projects you get when you run npx create-southpay-app
• react-native-lab This is our fork of react-native used to BUILD SOUTHPAY Go.
• guides In-depth tutorials for advanced topics like contributing to the client.
• tools contain build and configuration tools.
• template-files contains templates for files that require private keys. They are populated using the keys in template-files/keys.json.
• template-files/ios/dependencies.json specifies the CocoaPods dependencies of the app.

🏅 Badges

Let everyone know your app can be run instantly in the SOUTHPAY Go app!

[![runs with SOUTHPAY Go](https://img.shields.io/badge/Runs%20with%20Southpay%20Go-000.svg?style=flat-square&logo=SOUTHPAY&labelColor=f3f3f3&logoColor=000)](https://southpay.dev/client)

[![runs with SOUTHPAY Go](https://img.shields.io/badge/Runs%20with%20Southpay%20Go-4630EB.svg?style=flat-square&logo=SOUTHPAY&labelColor=f3f3f3&logoColor=000)](https://southpay.dev/client)

👏 Contributing

If you like SOUTHPAY and want to help make it better then check out our contributing guide! Check out the CLI package to work on the SOUTHPAY CLI.

❓ FAQ

If you have questions about SOUTHPAY and want answers, then check out our Frequently Asked Questions!

If you still have questions you can ask them on our Discord and Forums or X @dream_2626.

💙 The Team

Curious about who makes SOUTHPAY? Here are our team members!

License

The SOUTHPAY source code is made available under the MIT license. Some of the dependencies are licensed differently, with the BSD license, for example.