Skip to content

Commit 2caa02c

Browse files
chore: add Configure Required Services section
1 parent a12a39e commit 2caa02c

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,37 @@ You can modify these workflows based on your deployment environment. The templat
121121

122122
For detailed CI/CD guidance, refer to the [CodeBlock Dev Kit Documentation](https://docs.codeblock.dev/).
123123

124+
# ⚙️ Configure Required Services
125+
126+
After setting up and running the template, you need to configure essential services in the admin panel to ensure all pre-built modules work correctly and provide a complete user experience.
127+
128+
#### Access the Settings Page
129+
1. Run the `AdminPanel` project
130+
2. Navigate to the **Settings** page in the admin panel
131+
3. Configure the following three service providers:
132+
133+
#### Email Service Configuration
134+
- **Purpose**: Required for user registration, password reset, and notification emails
135+
- **Recommended**: [Mailgun](https://www.mailgun.com/) (suggested for production)
136+
- **Alternatives**:
137+
- [SendGrid](https://sendgrid.com/)
138+
- Self-hosted email server
139+
- **Setup**: Configure email settings with your chosen provider's credentials
140+
141+
#### SMS Service Configuration
142+
- **Purpose**: Required for two-factor authentication and SMS notifications
143+
- **Recommended**: [Twilio](https://www.twilio.com/)
144+
- **Setup**: Add your Twilio Account SID, Auth Token, and phone number
145+
146+
#### Payment Service Configuration
147+
- **Purpose**: Required for subscription management and payment processing
148+
- **Recommended**: [Stripe](https://stripe.com/)
149+
- **Setup**:
150+
1. Create a [Stripe account](https://dashboard.stripe.com/register)
151+
2. Configure payment settings with your Stripe API keys (Publishable Key and Secret Key)
152+
153+
**⚠️ Important**: These services are essential for the template to function properly. Without proper configuration, features like user authentication, notifications, and subscription management will not work correctly.
154+
124155
# 🛟 Support & Feedback
125156

126157
If you need help, have a question, or want to report a bug, you can create an issue and we will respond as soon as possible.

0 commit comments

Comments
 (0)