Simply Plural API is the backend for the app "Simply Plural". Simply Plural is created and managed by Apparyllis.
The SDK counterpart for Dart/Flutter can be found here.
You can support the development of Simply Plural by becoming a patron over at https://www.patreon.com/apparyllis. ❤️
Another way to support is by developing and submitting pull requests to this repository or our SDK for Dart/Flutter.
A big thank you to our biggest sponsor: The Plural Association ❤️
The Simply Plural API has a host of functionalities.
- GET, POST, PATCH, DELETE requests for all data-related activities for Simply Plural
- Event handlers such as Front Notifications and Reminders
- Creation and deletion of user accounts
- Exporting and creating reports of user data
- Uploading and deleting of user avatars
- Friend-related functionalities such as Add friends, Remove Friends, etc.
- Syncing information between Simply Plural and third party integrations such as PluralKit
Required:
DATABASE_URI: a MongoDB connection URI (for example,mongodb://localhost:27017)TLS_CERT,TLS_KEY: (if SSL is enabled) Path to SSL certificate and key.
Optional:
PORT: port to listen on (same for http or https - defaults to 8443)DISABLE_TLS: will disable HTTPS (for example, when behind a proxy or load balancer)SPACES_KEY,SPACES_SECRET: Key ID and secret for DigitalOcean Spaces
When doing cosmetic pull requests, such as typo fixes, formatting fixes, please PR into main. For any other pull requests, such as feature changes, new features, fixes, etc. please PR into the pretesting branch,