Appwrite

31SaaS integrates with Appwrite for database management and authentication. This document outlines the setup process and configuration required to get the boilerplate running.

Note

31SaaS is an official partner of Appwrite. Start your project with the Appwrite database for free, and when you’re ready to scale, take advantage of our enhanced support and benefits. Get $15 off by visiting our partner link.

Integrating with Appwrite

1. If you haven’t already, sign up for an Appwrite account.
2. Create a project and database within Appwrite.
3. Retrieve your project ID and set it as the environment variables APPWRITE_PROJECT_ID and NEXT_PUBLIC_APPWRITE_PROJECT_ID.
4. Generate an API key and set it as the environment variable APPWRITE_API_KEY.
5. Set your Appwrite endpoint URL as the environment variables APPWRITE_ENDPOINT and NEXT_PUBLIC_APPWRITE_ENDPOINT.
6. Configure two web app platforms in Appwrite: one for local development (set hostname as localhost) and one for production (set hostname as your production URL). The latter can be set up later when you are ready to go live.

Caution

When you are ready to go Production, remember to set up custom domain to prevent the browser storing cookieFallback and keep your app secure.

Database Collections

In your database, create these collections:

user

Stores user data and associated Stripe information.

Attribute

Attribute	Type	Required	Max Char	Default Value
stripeCustomerId	String		50
stripeSubscriptionId	String		50
email	Email	Yes
stripePlanQuantity	Int			0
stripeSubscriptionStatus	String		50
stripePriceId	String		50
createdAt	Date	Yes
stripeCurrentPeriodEnd	Date

Permission

Document security = enabled.
Grant any to create.

Index

Key	Type	Attributes	Asc/Desc
stripeCustomerId	key	stripeCustomerId	Asc

task

Stores demo dashboard data.

Attribute

Attribute	Type	Required	Max Char	Default Value
title	String	Yes	175
content	String		5000
createdAt	Date	Yes
status	Enum			pending

Use pending, wip, started, canceled as the status.

Permission

Document security = disabled.
Grant any to create, read, update, delete.

Caution

This permission setting is for demo purposes only. Ensure to set suitable and secure permissions for your collections based on your application’s requirements and security considerations.

subscriber

Stores subscriber emails from your landing page.

Attribute

Attribute	Type	Required	Max Char	Default Value
email	Email	Yes

Permission

Document security = disabled.
Grant any to create.