Skip to content

Latest commit

 

History

History
135 lines (99 loc) · 3.63 KB

README.md

File metadata and controls

135 lines (99 loc) · 3.63 KB

BuildFast Logo


BuildFast

Build your SaaS product landing page in hours, not days.
Super easy to customize Next.js boilerplate.
About · Get Started · Customize · Deploy

About BuildFast

BuildFast is a powerful and easy-to-use Next.js boilerplate designed to accelerate the development of SaaS product landing pages. With all essential features included and a highly customizable structure, you can have a fully functional and stylish landing page ready in no time.

Features

  • 🖌️ Fully Customizable: Update site content through a single configuration file.
  • ⚡ Modern Tech Stack: Built with Next.js and Tailwind CSS for scalability and aesthetics.
  • 🚀 Optimized for Speed: Get your landing page live in hours with minimal setup.
  • 💾 Ready for Deployment: Deploy seamlessly on platforms like Vercel.

Getting Started

Follow these steps to set up BuildFast:

  1. Clone the Repository: 
    git clone https://github.com/chiragksharma/BuildFast.git
cd BuildFast
  2. Install Dependencies 
    npm install
# or
yarn install
# or
pnpm install
# or
bun install
  3. Start the Development Server: 
    npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev
  4. Open in Browser: Navigate to http://localhost:3000 to view your site.

Project Structure

Here's an overview of the BuildFast project structure:

Folder Description
src/app/ Main application components
src/components/ Reusable UI components
src/config/ Configuration files (e.g., siteConfig.json)
src/context/ React context providers
src/customTypes/ Custom TypeScript types
src/hooks/ Custom React hooks
src/pages/ Next.js pages and API routes
src/styles/ Global styles and Tailwind CSS config
src/utils/ Utility functions

Customization

Easily update your landing page by modifying the siteConfig.json file located in the src/config/ directory. This file controls:

  • Text content
  • Branding
  • Layout options
  • SEO settings

With BuildFast, customization is quick and intuitive.

Deploy on Vercel

Why Vercel?

The Vercel Platform is the easiest way to deploy your Next.js app.

Steps to Deploy 🚀

  1. Login to Vercel: 
    npx vercel login

Authenticate via GitHub, GitLab, Bitbucket, or email.

  1. Run the Deployment Command: 
    npx vercel

Follow the interactive prompts to create a new project or link to an existing one.

Done! Your landing page is now live! 🎉

Learn More

To dive deeper into the features and capabilities of BuildFast, explore these resources:

Support & Contribution

Have questions or want to contribute? Open an issue or submit a pull request on the GitHub Repository.