my-next-starter

My Next.js Starter Code

This project is a starter code for Next.js applications. It provides a simple way to clone different versions of the project based on the options provided.

How it works

The script in index.ts is designed to clone a specific branch from a GitHub repository based on the options provided when running the script. The repository URL is set to https://github.com/talalajmi/nextjs-starter-code.git and the default branch is main.

There are two optional arguments that can be provided when running the script: supabase and auth. If the supabase argument is provided, the script will clone the supabase-version branch. If the auth argument is provided, the script will clone the auth-version branch.

After cloning the appropriate branch, the script will recursively replace placeholders in the project files. This is done by reading the files in a directory, and for each file, joining the directory path and the file name to get the full file path.

Installation

To use this script globally, you need to have Node.js and npm (Node Package Manager) installed on your machine. Once you have Node.js and npm installed, you can install the script globally with the following command:

npm install -g my-next-starter

After installing the script globally, you can use it from anywhere with the following command:

create-next-starter <project-name> [options]

Replace with the name of your new project. The [options] can be --auth or -a to include authentication setup, or --supabase or -s to include Supabase setup (which implies authentication). There is also one more setup which is -a-s or -auth-supabase, this for for clerk for authentication and user management and supabase as a backend as a service

For example, if you want to create a new project named my-new-project with authentication setup, you can run the following command:

create-next-starter my-new-project -a

create-next-starter my-new-project -auth

If you want to create a new project named my-new-project with supabase setup, you can run the following command:

create-next-starter my-new-project -s

create-next-starter my-new-project -supabase

If you want to create a new project named my-new-project with supabase setup and clerk for auth, you can run the following command:

create-next-starter my-new-project -a-s

create-next-starter my-new-project -auth-supabase