Add exclude parameter to project creation

Major additions:
- '.env.local' updated dynamically based on 'exclude' value
- 'uploadthing' files split into separate folder in 'setup_assets'. Only added to project when required
- Add logic to remove 'uploadthing' remote pattern from 'next.config.mjs'
- Add logic to remove 'exclude' packages from 'package.json'

Minor additions:
- Split 'not sure where to start?' output into sections and add items to it
- Add style replacement for 'shadcn/ui': 'new-york' -> 'default'

Author: Achronus

README.md

@@ -42,14 +42,18 @@ All projects are created using the same stack, consisting of the following:
 
 2. Frontend
 
-   - [NextJS](https://nextjs.org/)
-   - [TailwindCSS](https://tailwindcss.com/)
-   - [TypeScript](https://www.typescriptlang.org/)
-   - [Uploadthing](https://uploadthing.com/)
-   - [Clerk](https://clerk.com/docs/quickstarts/nextjs)
-   - [Stripe](https://stripe.com/docs)
-   - [Lucide React](https://lucide.dev/)
-   - [Shadcn UI](https://ui.shadcn.com/)
+   a. Core:
+
+     - [NextJS](https://nextjs.org/)
+     - [TailwindCSS](https://tailwindcss.com/)
+     - [TypeScript](https://www.typescriptlang.org/)
+     - [Lucide React](https://lucide.dev/)
+     - [Shadcn UI](https://ui.shadcn.com/)
+
+   b. Optional:
+     - [Clerk](https://clerk.com/docs/quickstarts/nextjs)
+     - [Uploadthing](https://uploadthing.com/)
+     - [Stripe](https://stripe.com/docs)
 
 _Note: all libraries and packages are automatically installed to their latest versions when running the tool._
 
@@ -65,10 +69,13 @@ We've also added some extra files too! You can find out more about them in our [
    pip install create_api_app
    ```
 
-3. Create a project:
+3. Create a project with a `name` and an `optional` string of `exclusion` characters for the `optional` packages.
+
+   Exclusion options: `c`, `u`, `s`, `cs`, `cu`, `us`, `cus`.
+   _`c` = `Clerk`, `u` = `Uploadthing`, `s` = `Stripe`_
 
    ```python
-   create-api-app <project_name>
+   create-api-app <project_name> <exclusions>
    ```
 
 And that's it! You'll find two folders in your project, one called `frontend` (for NextJS) and another called `backend` (for FastAPI).

_project_demo/frontend/components.json

@@ -1,6 +1,6 @@
 {
   "$schema": "https://ui.shadcn.com/schema.json",
-  "style": "new-york",
+  "style": "default",
   "rsc": true,
   "tsx": true,
   "tailwind": {
@@ -14,4 +14,4 @@
     "components": "@/components",
     "utils": "@/lib/utils"
   }
-}
+}

create_api_app/conf/constants/__init__.py

@@ -1,3 +1,8 @@
+from enum import StrEnum
+
+from create_api_app.conf.storage import Package, Packages
+
+
 # Define core backend packages
 BACKEND_CORE_PACKAGES = [
     "fastapi",
@@ -19,3 +24,35 @@
 PASS = "[green]\u2713[/green]"
 FAIL = "[red]\u274c[/red]"
 PARTY = ":party_popper:"
+
+
+class ExcludeOptions(StrEnum):
+    clerk = "c"
+    uploadthing = "u"
+    stripe = "s"
+    clerk_n_stripe = "cs"
+    clerk_n_uploadthing = "cu"
+    uploadthing_n_stripe = "us"
+    all = "cus"
+
+
+clerk = Package(
+    name="clerk",
+    letter="c",
+    dependencies=["@clerk/nextjs"],
+    colour="cyan",
+)
+uploadthing = Package(
+    name="uploadthing",
+    letter="u",
+    dependencies=["uploadthing", "@uploadthing/react"],
+    colour="red",
+)
+stripe = Package(
+    name="stripe",
+    letter="s",
+    dependencies=["@stripe/react-stripe-js", "@stripe/stripe-js"],
+    colour="magenta",
+)
+
+PACKAGES = Packages([clerk, uploadthing, stripe])

create_api_app/conf/constants/content.py

@@ -1,3 +1,6 @@
+from create_api_app.conf.storage import Packages
+
+
 class PoetryContent:
     """A helper class for retrieving content for the Poetry installation."""
 
@@ -28,3 +31,77 @@ def tailwind_font(self) -> str:
                 "      },",
             ]
         )
+
+    @classmethod
+    def ut_remote_pattern(cls) -> list[str]:
+        """Provides the `uploadthing` `remotePattern` found in the `next.config.mjs` file."""
+        return [
+            "      {\n",
+            '        protocol: "https",\n',
+            '        hostname: "utfs.io",\n',
+            "        pathname: `/a/${process.env.NEXT_PUBLIC_UPLOADTHING_APP_ID}/*`,\n",
+            "      },\n",
+        ]
+
+
+class EnvFileContent:
+    """A helper class for creating the `.env.local` file."""
+
+    def __init__(self, packages: Packages) -> None:
+        self.packages = packages
+
+    def uploadthing(self) -> list[str]:
+        """Returns the `Uploadthing` API key content."""
+        return [
+            "# Uploadthing: storing files and handling file uploading",
+            "# https://uploadthing.com/",
+            "UPLOADTHING_SECRET=",
+            "NEXT_PUBLIC_UPLOADTHING_APP_ID=",
+            "",
+        ]
+
+    def clerk(self) -> list[str]:
+        """Returns the `Clerk` API key content."""
+        return [
+            "# Clerk: User Authentication",
+            "# https://clerk.com/docs/quickstarts/nextjs",
+            "NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=",
+            "CLERK_SECRET_KEY=",
+            "",
+            "NEXT_PUBLIC_CLERK_SIGN_IN_URL=/auth/sign-in",
+            "NEXT_PUBLIC_CLERK_SIGN_UP_URL=/auth/sign-up",
+            "NEXT_PUBLIC_CLERK_AFTER_SIGN_IN_URL=/",
+            "NEXT_PUBLIC_CLERK_AFTER_SIGN_UP_URL=/",
+            "",
+        ]
+
+    def stripe(self) -> list[str]:
+        """Returns the `Sstripe` API key content."""
+        return [
+            "# Stripe: user payments",
+            "# https://stripe.com/docs",
+            "NEXT_PUBLIC_STRIPE_PUBLISHABLE_KEY=",
+            "STRIPE_SECRET_KEY=",
+            "STRIPE_WEBHOOK_SECRET=",
+            "NEXT_PUBLIC_STRIPE_CLIENT_ID=",
+            "NEXT_PUBLIC_PLATFORM_SUBSCRIPTION_PERCENT=1",
+            "NEXT_PUBLIC_PLATFORM_ONETIME_FEE=2",
+            "NEXT_PUBLIC_PLATFORM_PERCENT=1",
+            "NEXT_PRODUCT_ID=",
+            "",
+        ]
+
+    def make(self) -> str:
+        """Creates the `env` file content."""
+        map = {
+            "clerk": self.clerk(),
+            "uploadthing": self.uploadthing(),
+            "stripe": self.stripe(),
+        }
+
+        content = []
+        for package in self.packages.items:
+            if not package.exclude:
+                content.extend(map[package.name])
+
+        return "\n".join(content)

create_api_app/conf/constants/filepaths.py

@@ -11,6 +11,8 @@ class SetupAssetsDirNames:
     BACKEND = "backend"
     APP = "app"
 
+    UPLOADTHING = "uploadthing"
+
 
 class AssetFilenames:
     """A storage container for asset filenames."""
@@ -33,6 +35,7 @@ class SetupDirPaths:
     BACKEND_ASSETS = DIRPATHS_DICT[SetupAssetsDirNames.BACKEND]
     FRONTEND_ASSETS = DIRPATHS_DICT[SetupAssetsDirNames.FRONTEND]
     ROOT_ASSETS = DIRPATHS_DICT["root"]
+    UPLOADTHING_ASSETS = DIRPATHS_DICT[SetupAssetsDirNames.UPLOADTHING]
 
 
 def __dotenv_setter(name: str, value: str) -> None:
@@ -43,6 +46,10 @@ def set_project_name(name: str) -> None:
     __dotenv_setter("PROJECT_NAME", name)
 
 
+def set_exclude_value(value: str) -> None:
+    __dotenv_setter("EXCLUDE", value)
+
+
 def set_poetry_version(version: str) -> None:
     __dotenv_setter("POETRY_VERSION", version)
 
@@ -51,6 +58,10 @@ def get_project_name() -> str:
     return os.environ.get("PROJECT_NAME")
 
 
+def get_exclude_value() -> str:
+    return os.environ.get("EXCLUDE")
+
+
 def get_poetry_version() -> str:
     return os.environ.get("POETRY_VERSION")
 
@@ -72,3 +83,11 @@ def __init__(self, project_name: str = None) -> None:
         self.ENV_LOCAL = os.path.join(self.ROOT, ".env.local")
         self.SETTINGS = os.path.join(self.BACKEND_APP, "config", "settings.py")
         self.MODELS = os.path.join(self.BACKEND_APP, "models", "__init__.py")
+
+        self.PACKAGE_JSON = os.path.join(self.FRONTEND, "package.json")
+        self.NEXT_CONF = os.path.join(self.FRONTEND, "next.config.mjs")
+        self.SHAD_CONF = os.path.join(self.FRONTEND, "components.json")
+        self.LAYOUT = os.path.join(self.FRONTEND, "src", "app", "layout.tsx")
+        self.HOMEPAGE = os.path.join(
+            self.FRONTEND, "src", "pages", "Homepage", "Homepage.tsx"
+        )

create_api_app/conf/file_handler.py

@@ -1,11 +1,15 @@
-
-
 def write_to_file(item: str, path: str) -> None:
     """Stores an item in a file."""
     with open(path, "w") as file:
         file.write(item)
 
 
+def append_to_file(item: str, path: str) -> None:
+    """Appends content to a file."""
+    with open(path, "a") as file:
+        file.write(item)
+
+
 def add_content_to_file(content: str, path: str) -> None:
     """Writes multiple lines (`content`) to a file at `path`."""
     with open(path, "w") as file:
@@ -14,23 +18,19 @@ def add_content_to_file(content: str, path: str) -> None:
 
 def read_all_file_content(path: str) -> str:
     """Retrieves all content from a basic file."""
-    with open(path, 'r') as file:
+    with open(path, "r") as file:
         content = file.read()
-    
+
     return content
 
 
 def insert_into_file(position: str, new_content: str, path: str) -> None:
     """Adds `new_content` to a file (`path`) at a specific `position`.
-    
+
     Note: `new = (position + new_content).strip()`."""
     content = read_all_file_content(path)
 
-    content = content.replace(
-        position,
-        (position + new_content).strip(),
-        1
-    )
+    content = content.replace(position, (position + new_content).strip(), 1)
 
     add_content_to_file(content, path)
 
@@ -39,10 +39,6 @@ def replace_content(old: str, new: str, path: str, count: int = 1) -> None:
     """Replaces `old` content with `new` ones in a file at `path`."""
     content = read_all_file_content(path)
 
-    content = content.replace(
-        old,
-        new.strip(),
-        count
-    )
+    content = content.replace(old, new.strip(), count)
 
     add_content_to_file(content, path)

create_api_app/conf/storage.py

@@ -0,0 +1,46 @@
+from dataclasses import dataclass
+
+
+@dataclass
+class Package:
+    """Represents a single package."""
+
+    name: str
+    letter: str
+    dependencies: list[str]
+    colour: str
+    exclude: bool = False
+
+    def update_exclude(self, exclude: str) -> None:
+        """Updates `self.exclude` to `True` if its `self.letter` exists in the `exclude` parameter."""
+        self.exclude = True if self.letter in exclude else False
+
+    def name_str(self) -> str:
+        """Returns the name wrapped in its colour as a string."""
+        return f"[{self.colour}]{self.name}[/{self.colour}]"
+
+
+@dataclass
+class Packages:
+    """Stores multiple packages."""
+
+    items: list[Package]
+
+    def update(self, exclude: str) -> None:
+        """Updates the packages based on the given parameters."""
+        if exclude:
+            for package in self.items:
+                package.update_exclude(exclude)
+
+    def exclusions(self) -> list[Package]:
+        """Retrieves the packages that are excluded from the project."""
+        return [package for package in self.items if package.exclude]
+
+
+@dataclass
+class RemotePattern:
+    """A storage container representing a `remotePattern` found in the `next.config.mjs`."""
+
+    protocol: str = None
+    hostname: str = None
+    pathname: str = None