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
Database:
DATABASE_URI: a MongoDB connection URI (for example,mongodb://localhost:27017)DBNAME: Name of the database
Mail:
MAILPORT: Port for the SMTP serverMAILHOST: Hostname for the SMTP serverMAILUSER: Username for the SMTP serverMAILPASSWORD: Password for the SMTP server
Sentry:
SENTRY_DSN: DSN for the Sentry integration
Storage:
MINIO_KEY: Key for MinIOMINIO_Secret: Secret for MinIOOBJECT_HOST
GOOGLE_CLIENT_IDGOOGLE_CLIENT_AUDGOOGLE_CLIENT_IOS_IDGOOGLE_CLIENT_SECRET
Hash:
PASSWORD_KEYPASSWORD_SEPERATOR
JWT:
JWT_KEYGOOGLE_CLIENT_JWT_AUD
Environment:
PRETESTINGDEVELOPMENTUNITESTLOCAL
Chat
MESSAGES_KEY
Optional:
PORT: port to listen on, default 3000LOGPREFIX: Prefix to add to logfilesPLURALKITAPP: PluralKit-granted header to have an increased rate limitLOCALEVENTS: Whether to run the event controllerSOCKETEMIT: Whether to enable the socket emits for Mongodb changes
When doing any pull requests, please PR into pretesting.
