🚀
eziSaas
Github Repository
  • Welcome
  • 📕GUIDES
    • Getting Started
    • Environment Variables Setup
  • 🖥️SERVER
    • Overview
    • /config/mail.js
    • /controllers/authController.js
    • /routes/payment.js
    • /routes/webhook.js
  • 📦Components & PAGES
    • Landing
      • Navbar
      • CheckoutButton
      • Hero
      • SellingPoints
        • SellingPoint
        • Filter
      • Title
        • OfferPill
      • Video
      • Pricing
        • PricingCard
      • Faq
        • Accordion
      • FinalMessage
      • Footer
        • FooterSection
    • Login
    • Success
    • Failure
    • Dashboard
      • ChangePassword
  • OTHER
    • Github Repository
Powered by GitBook
On this page
  • Step 1: Purchase eziSaas
  • Step 2: Receive Email Notifications
  • Step 3: Accept the GitHub Invitation
  • Step 4: Clone the Repository
  • Step 5: Install Dependencies
  • Step 6: Set Up Environment Variables
  • Step 7: Run the Application
  • Step 8: Customize Your SaaS Application
  1. GUIDES

Getting Started

This short guide will show you how to get started with the boilerplate within a few minutes.

PreviousWelcomeNextEnvironment Variables Setup

Last updated 6 months ago

Step 1: Purchase eziSaas

First, you'll need to purchase the eziSaas boilerplate. Visit our purchase page and complete the payment process using our integrated Stripe payment system.

Step 2: Receive Email Notifications

Once your payment is complete, you will receive two important emails:

  1. Email from eziSaas:

    • This email contains a temporary password for you to log into your mini-dashboard.

  2. Email from GitHub:

    • This email includes an invitation to join the eziSaas repository as a collaborator (read-only).

Step 3: Accept the GitHub Invitation

Open the email from GitHub and accept the invitation to collaborate on the eziSaas . This will give you access to the boilerplate code. Note that you have 7 days to accept the invitation.

  1. Click on the invitation link in the email.

  2. Log in to your GitHub account (or create one if you don't have one).

  3. Accept the invitation to join the repository.

Step 4: Clone the Repository

Now that you have access to the repository, clone it to your local machine to start customizing your SaaS application.

  1. Open your terminal.

  2. Navigate to the directory where you want to clone the repository.

  3. git clone https://github.com/sidaliterkmane/ezisaas.git

Step 5: Install Dependencies

Before you can run the application, you need to install the required dependencies.

  1. Run the following command to install the dependencies for both the client and server: npm install

Step 6: Set Up Environment Variables

Create a .env file in the root directory of the project and add the necessary environment variables. You can use the provided .env.example file as a template. Make sure to include your Stripe API keys and MongoDB connection string.

Step 7: Run the Application

With everything set up, you can now run the application. Use the following commands to start both the client and server:

Inside the client folder: npm run dev

Inside the server folder: npm start

At this point, your frontend application should be running at http://localhost:5173/ and your backend application at http://localhost:3000/

Step 8: Customize Your SaaS Application

With the boilerplate up and running, you can start customizing your SaaS application to suit your needs. Explore the codebase, modify the components, and implement your unique features to create a fully functional SaaS application.


That's it! You're now ready to build and launch your micro-SaaS application with eziSaas. Happy coding!


Ensure you have installed on your machine v22.9.0.

📕
repository
Node.js