The smart way to power your store's payments.
Lightweight, customizable and beautiful by default.
## Overview
StellarPay is a next-generation payment gateway that allows you to accept one-time and subscription (coming soon!)
payments from your customers. It is a WordPress plugin that is built with the latest technologies and is designed to be
highly customizable and extendable.
## Features
- ๐ **Built in React**
- โ๏ธ **Settings UI and Data Store** - _Customizable UI fields with Data Store_
- ๐๏ธ **Blocks Development Workflow**
- ๐ **PHP Autoloader**
- โจ **TailwindCSS**
## Installation
### Step 1
Set up a new LocalWP environment with the following settings:
1. **Web Server:** Nginx
2. **PHP Version:** 8.2.10
3. **Database:** MySQL 8.0.16
4. **Site Domain:** stellarpay.test
### Step 2
Make sure you have PHP, Composer and NodeJS installed on your machine. And then run the following bash command -
```sh
bun run install-scripts && bun run build
```
### Step 3
Familiarize yourself with some of the commands and start developing โก๏ธ
```bash
bun run dev:scripts
```
## Documentation (WIP)
We're working on the documentation for this project.
## Contribute
Thank you for thinking about contributing to StellarPay! This project is part of the StellarWP organization and is open
source for everyone to use and contribute to. We are excited to see what you can bring to the table.
### UI text guidelines
#### Use of sentence sase
To ensure consistency and readability across the user interface (UI), all text elements within the plugin's UI should
follow **Sentence case**.
**What is Sentence case?**
Sentence case is a style of writing where only the first letter of the first word in a sentence is capitalized, along
with any proper nouns. This approach is generally used to make text more readable and approachable. Here's an example:
- **Sentence case**: "This is an example of sentence case."
- **Title Case**: "This Is an Example of Title Case."
**Why use Sentence case?**
- **Readability**: Sentence case is easier to read, especially for longer sentences or descriptive text.
- **Consistency**: Maintaining Sentence case throughout the UI creates a uniform and professional appearance.
- **User-Friendly**: This style aligns with most modern UI/UX best practices, enhancing the overall user experience.
When adding or editing any UI text, please ensure that Sentence case is applied consistently across all elements.
## Security
Need to report a security vulnerability? Email us at [security@stellarwp.com](mailto:security@stellarwp.com).
## License
StellarPay is licensed under [GNU General Public License v2 (or later)](./license.txt).