FullStackStarterKit

This repository is a comprehensive template for starting full-stack web development projects, pre-configured with Next.js, Clerk, Convex, ShadcnUI, and TailwindCSS.

I created this because I needed a quick way to start new projects with all the tools I use regularly. I hope you find it useful too!

How to Use the FullStackStarterKit

To clone this template and start your own project, follow these instructions.

Step 1: Clone the Template

git clone https://github.com/joeBlockchain/full-stack-starter-kit.git YourNewProjectName
cd YourNewProjectName

Step 2: Initialize Your Project

rm -rf .git
git init

Step 3: Create a New GitHub Repository

Create a new repository on GitHub for your project. Do not initialize it with any files since your project already includes them.

Step 4: Link Your Project to the New Repository

git remote add origin https://github.com/your_username/YourNewProjectName.git
git add .
git commit -m "Initial commit from FullStackStarterKit"
git branch -M main
git push -u origin main

Step 5: Install Dependencies

npm install

Or if you're using Yarn:

yarn

Step 6: Start Development Server

With Clerk and Convex configured, and dependencies installed, start the development server:

npm run dev

Or with Yarn:

yarn dev

Visit http://localhost:3000 to see your application.

Step 7: Set Up Convex

1. In a new terminal, run the following command to initialize your Convex development environment:

   npx convex dev

2. Follow the prompts to configure a new Convex project.

3. The CLI will automatically update your .env.local with the necessary Convex configuration.

Step 8: Set Up Clerk

1. Visit Clerk Dashboard and create an account or log in.

2. Create a new instance for your project and obtain your Clerk Frontend API Key and Clerk Secret Key.

3. Copy .env.local.sample to a new file named .env.local and fill in your Clerk keys:

   NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=
   CLERK_SECRET_KEY=
   

4. navigate to JWT templates and create a new template and select convex as the provider

5. copy the jwt issuer token and add to env.local file

   CLERK_JWT_ISSUER_DOMAIN=
   

Step 9: Set Up Stripe

1. create account on stripe

2. obtain api key for developers

3. copy secret key and add to env.local file

   STRIPE_SECRET_KEY=your_stripe_secret_key
   

4. add stripe key to convex

Contributing

We welcome contributions to the FullStackStarterKit! Please see the contribution guidelines for more details.

License

This project is licensed under the MIT License.

---

This revised README includes all the necessary steps for users to get started with your FullStackStarterKit, ensuring they can seamlessly set up Clerk and Convex for their projects.