Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
JRH89 committed Sep 2, 2024
1 parent 584ab05 commit 864dd65
Show file tree
Hide file tree
Showing 6 changed files with 25 additions and 31 deletions.
1 change: 1 addition & 0 deletions pages/_meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
"admin-dashboard": "Step 7: Create Admin User",
"wrapping-up": "Wrapping Up",
"checklist": "Checklist",
"customizing-theme": "Customizing Theme",
"using-react-toasts": "Customizing Toast Notifications (optional)",
"about": {
"title": "About",
Expand Down
2 changes: 1 addition & 1 deletion pages/about.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

### **SaaSavant** is your ultimate starting point for building powerful and scalable SaaS applications. Tailored for developers and startups, SaaSavant streamlines the creation of robust, feature-rich products with:

- **[NextJS](https://nextjs.org/)** for seamless server-side rendering and dynamic routing.
- **[Next.js](https://nextjs.org/)** for seamless server-side rendering and dynamic routing.
- **[Firebase](https://firebase.google.com/)** for real-time database management, authentication, and cloud functions.
- **[Stripe](https://stripe.com/)** for effortless integration of secure and customizable payment processing.
- **[SendGrid](https://sendgrid.com)** for reliable and scalable email services to keep your users engaged.
Expand Down
1 change: 1 addition & 0 deletions pages/checklist.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ Setup:
- [ ]: Setup siteMetadata.js
- [ ]: Setup firebase
- [ ]: Setup stripe
- [ ]: Connect firebase to stripe
- [ ]: Setup sendgrid
- [ ]: Create admin user

Expand Down
8 changes: 8 additions & 0 deletions pages/customizing-theme.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@

## Customizing the Theme

The theme in SaaSavant is built with [Tailwind CSS](https://tailwindcss.com/). You can customize the theme in `tailwind.config.js` in the root directory of your project.

Change the `confirm` and `destructive` color values to match your brand. The blue and pink color seen on the landing page and throughout the app are the defaults based on these two values.

![Demo 11](../public/edit-theme.png)
18 changes: 13 additions & 5 deletions pages/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,12 @@ SaaSavant is a robust and feature-rich SaaS boilerplate designed to accelerate y

SaaSavant was built with the following technologies:

- [NextJS](https://nextjs.org/)
- [Next.js](https://nextjs.org/)
- [JavaScript](https://developer.mozilla.org/en-US/docs/Web/JavaScript)
- [TypeScript](https://www.typescriptlang.org/)
- [Firebase](https://firebase.google.com/)
- [Stripe](https://stripe.com/)
- [SendGrid](https://sendgrid.com/)

- [JavaScript](https://developer.mozilla.org/en-US/docs/Web/JavaScript)
- [TypeScript](https://www.typescriptlang.org/)
- [tailwindcss](https://tailwindcss.com/)
- [Framer Motion](https://www.framer.com/motion/)

Expand Down Expand Up @@ -71,7 +70,7 @@ SaaSavant integrates seamlessly with Stripe to handle subscription payments. The

The admin dashboard in SaaSavant provides a comprehensive interface for managing your application. Key features include:

### Paginated User List and Support Ticket Components
### User List and Support Ticket Components

- **User Management**: View and manage all registered users.
- **Support Ticket Management**: View and manage all support tickets.
Expand Down Expand Up @@ -172,6 +171,15 @@ When you build or deploy your SaaSavant project, a sitemap is automatically gene
- **Complete URL List**: The sitemap includes all the URLs of your site, aiding search engines in discovering and indexing your content.
- **Robots.txt**: Allows search engines to crawl and index your site.

### **5. Vercel Analtrics and Speed Insights**

SaaSavant includes support for Vercel Analytics and Speed Insights, which provide valuable insights into your site's performance.

- **Vercel Analytics**: Collects analytics data from your site and sends it to Vercel, which provides insights into your site's performance.
- **Speed Insights**: Collects performance data from your site and sends it to Vercel, which provides insights into your site's performance.

Just enable them in your project settings from the Vercel dashboard, we've done everything else for you.

By incorporating these features, SaaSavant ensures that your site is well-optimized for search engines and social media, helping you achieve better visibility and engagement.

### Responsive Design
Expand Down
26 changes: 1 addition & 25 deletions pages/wrapping-up.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ Let's wrap up by completing our `.env.local`, `siteMetadata.js`, and `tailwind.c
In a production environment, it's crucial to ensure that your Firestore rules protect sensitive data while allowing the necessary access. Here's a sample Firestore rule set that allows anyone to read documents but only authenticated users can write or delete:

```json
rules_version = '2';
service cloud.firestore {
match /databases/{database}/documents {
// Allow anyone to read any document
Expand Down Expand Up @@ -72,28 +73,3 @@ If you are using Stripe Development Mode API Keys (recommended while developing
When you are done testing, replace the keys in the `.env.local` file with your live keys and turn off the development mode in the Stripe Dashboard.

![Demo 11](../public/demo-11.png)

## Checklist:

Setup:
- [ ]: Setup .env.local
- [ ]: Setup siteMetadata.js
- [ ]: Setup project
- [ ]: Setup firebase
- [ ]: Setup stripe
- [ ]: Setup sendgrid
- [ ]: Create admin user

Develop:
- [ ]: Build your Saas
- [ ]: Edit theme in 'tailwind.config.js'

Deploy:
- [ ]: Change Firestore to Production Mode in Firebase Settings adjust rules
- [ ]: Change Stripe to Production Mode in Stripe Settings
- [ ]: Change Firebase to Production Mode in Firebase Settings
- [ ]: Change Firestore rules to production using the provided rules above
- [ ]: Change the `NEXT_PUBLIC_BASE_URL` in `.env.local`
- [ ]: Run `yarn dev` or `npm run dev`
- [ ]: Test app
- [ ]: Deploy

0 comments on commit 864dd65

Please sign in to comment.