@a5gard/bifrost 1.0.1

package/README.md

@@ -0,0 +1,282 @@
+# @a5gard/bifrost
+
+Platform-agnostic project creator with extensible template system inspired by Remix Stacks.
+
+## Features
+
+- 🌈 **Platform Agnostic**: Works with any framework (Remix, Next.js, Vite, etc.)
+- 📦 **Multiple Package Managers**: Support for npm, pnpm, yarn, and bun
+- 🎯 **Git-based Stacks**: Use any GitHub repository as a template
+- 🚀 **Interactive CLI**: Guided setup with smart prompts
+- ⚡ **Fast Setup**: Clone, configure, and install in seconds
+- 🔄 **Auto Git Push**: Optionally push initial commit to GitHub
+
+## Usage
+
+### Interactive Mode
+
+```bash
+bunx @a5gard/bifrost
+```
+
+In interactive mode, the following prompts will display:
+- What would you like to name your new project?
+- Which platform would you like to use?
+- Which package manager do you prefer?
+- Would you like to have the install command run once the project has initialized?
+- Would you like to auto create and push the first commit to GitHub?
+- [!NEW] `config.bifrost` wizard
+- [!NEW] Submit template to bifrost registry
+
+
+### With Options
+
+```bash
+bunx @a5gard/bifrost my-app --template owner/repo --pkg-mgr bun
+```
+
+### Full Example
+
+```bash
+bunx @a5gard/bifrost my-app -s remix-run/indie-template -p bun
+```
+
+### Platform Templates
+
+```bash
+bunx @a5gard/bifrost my-app --list-templates
+```
+
+## Options
+
+| Flag | Alias | Description |
+|------|-------|-------------|
+| `--template` | `-s` | Stack to use (format: owner/repo) |
+| `--pkg-mgr` | `-p` | Package manager (npm, pnpm, yarn, bun) |
+| `--no-install` | | Skip dependency installation |
+| `--help` | `-h` | Show help |
+| `--version` | `-V` | Show version |
+
+## `config.bifrost wizard`
+
+```bash
+bunx @a5gard/bifrost wizard
+```
+
+The wizard will help guide you through the process of the templates config file by going over the following questions:
+- description
+- repo ( if it doesn't sense the data by scanning your project, it will prompt you to push your current project and create a public repo )
+- tags that you would like to associate with your template
+- post install scripts that are required to run once the project has initialized, providing the npm scripts names in a csv format
+- in a csv format, provide any and all plugins that you would like to include with your template to be installed and used with your template'
+
+It will then create config.bifrost for you with the submitted data, and if no values are missing will prompt you, asking if you would like to submit your template at this time. The only requirements for submitting is for the repo to be public and that your template includes the bifrost config file
+
+```json
+// config.bifrost
+{
+  "name": "My Stack",
+  "description": "A custom template for X platform",
+  "platform": "remix",
+  "github": "owner/repo",
+  "tags": ["react", "typescript", "tailwind"],
+  "postInstall": ["setup", "db:generate"],
+  "plugins": ["owner/plugin1", "owner/plugin2"]
+}
+```
+
+## `Submit template to bifrost registry`
+
+As long as your project already has a public repo already in place, if not it will prompt you to do so at this time, and the required `config.bifrost`. If you don't currently have the config file, it will start the config wizard to help you create it.
+
+```bash
+bunx @a5gard/bifrost submit
+```
+
+
+### Stack Configuration (Optional)
+
+Add a `config.bifrost` to your repository root for enhanced functionality:
+
+```json
+{
+  "name": "My Stack",
+  "description": "A custom template for X platform",
+  "platform": "remix",
+  "github": "owner/repo",
+  "tags": ["react", "typescript", "tailwind"],
+  "postInstall": ["setup", "db:generate"],
+  "plugins": ["owner/plugin1", "owner/plugin2"]
+}
+```
+
+# @a5gard/bifrost-plugin
+
+Plugin installer / wizard for bifrost projects.
+
+## Installing A Plugin
+
+### Interactive Mode
+
+Once your project has completed its installation process, you may now cd into the newly created directory and run:
+
+```bash
+bunx @a5gard/bifrost-plugin
+```
+
+Entering interactive mode it will display the following options:
+- List available plugins to install
+- Plugin wizard ( guide in creating your own plugin )
+- Submit Plugin
+
+## `List available plugins to install` 
+
+Running the following command will start plugin installation process:
+
+```bash
+bunx @a5gard/bifrost-plugin list
+```
+
+The installer will then obtain the list of available plugins to choose from the @a5gard/bifrost-plugin repo (owner `8an3`) from the file labeled `registry.bifrost`
+
+### Direct Installation
+
+or you may use the supplied method 
+
+```bash
+bunx @a5gard/bifrost-plugin otp-auth-plugin
+```
+
+Which will immediatly start the installation process, after scanning your projects config.bifrost to see if the platforms match for compatibility to ensure you are installing the correct plugin.
+
+## `Plugin wizard`
+### Creating your own plugin
+
+Running the following command will start the create plugin wizard:
+
+```bash
+bunx @a5gard/bifrost-plugin create
+```
+
+Where it will then inquirer:
+- name of plugin ( req )
+- platform ( req )
+- description ( req )
+- tags you would like to have associated with your plugin
+- will ask if you would like to supply the req. libraries now
+  - a placeholder will display the format to input the library names but will go as follows @remix-run/react, remix-auth, react
+- auto push / create github repo
+
+It will then create:
+- create `files/` folder
+- run `npm init`
+- push to github
+- create a readme containing a plugin guide and links to the site in order to submit your new plugin and discover others
+- create `plugin.bifrost` configuration file, filing in all the fields that it had gotten from you during the setup process
+  - name
+  - description
+  - platform
+  - tags, if you completed this step
+  - libraries, if you completed this step
+  - github
+
+Plugins are to be made with their own repo so as it can host all the required files for the plugin. 
+The repo is required to include a json config file labeled `plugin.bifrost` and a folder labeled `files` where it will host all the required files.
+When installing a plugin it will prompt the user to either confirm the default supplied file location or the use can also edit the location to suite their use cases needs.
+
+### plugin.bifrost
+
+```json
+{
+  "name": "otp-auth-plugin",
+  "description": "A custom one time password auth plugin for the remix platform",
+  "platform": "remix",
+  "github": "8an3/otp-auth-plugin",
+  "tags": ["remix-run", "auth", "one-time-password"],
+  "libraries": ["remix-auth-totp","remix-auth","@catalystsoftware/icons","@prisma/client","resend"],
+  "files": [
+        {
+        "name": "email.tsx",
+        "location": "app/components/catalyst-ui/utils/email.tsx"
+        },
+        {
+        "name": "client-auth.tsx",
+        "location": "app/components/catalyst-ui/utils/client-auth.tsx"
+        },
+        {
+        "name": "auth-session.ts",
+        "location": "app/components/catalyst-ui/utils/auth-session.ts"
+        },
+        {
+        "name": "prisma.ts",
+        "location": "app/components/catalyst-ui/utils/prisma.ts"
+        },
+        {
+        "name": "login.tsx",
+        "location": "app/routes/auth/login.tsx"
+        },
+        {
+        "name": "lougout.tsx",
+        "location": "app/routes/auth/lougout.tsx"
+        },
+        {
+        "name": "signup.tsx",
+        "location": "app/routes/auth/signup.tsx"
+        },
+        {
+        "name": "magic-link.tsx",
+        "location": "app/routes/auth/magic-link.tsx"
+        },
+             {
+        "name": "verify.tsx",
+        "location": "app/routes/auth/verify.tsx"
+        },
+    ],
+    "configs":[]
+}
+```
+
+## `Submit Plugin`
+
+Running the following command will start the submission process without the need of interactive mode:
+
+```bash
+bunx @a5gard/bifrost-plugin submit
+```
+
+Selecting this option will automate the submission process for you, adding your plugin to the libraries registry. Allowing you to share you plugin with others that will also be posted on the site to allow users to find it more easily. 
+
+
+## Searching / Posting Templates and Plugins
+
+Shortly a site will be available for use where you can search for templates and plugins.
+
+Feature two tabs, both tabs will host a filtering section located to the left of the pages content and a search bar located at the top of each tabs section. Allowing you to filter by platform, tags, etc meanwhile the search bar will allow you to search for individual templates or plugins for you to use.
+
+### Templates
+
+Each template result will display:
+- name
+- description
+- platform
+- command line to install the template
+- tags
+- any plugins that are to be included with the templates installation 
+
+### Plugins
+
+Each plugin result will display
+- name
+- description
+- platform
+- command line to install the plugin
+- tags
+- required libraries
+- required files
+
+### Submitting
+
+Whether its a template or plugin, you will have the ability to submit your own to be included with its respective registry, this step is not required or needed but will help in its overall discoverability.
+All you have to do in order to submit is supply your templates or plugins config file once you start the submission process. The pages nav bar will host a `submit` button in order to start the process.
+
+Upon submission the website will automatically update the relevant registry file and push the update to github to ensure the process is automated.

package/dist/index.d.ts

@@ -0,0 +1 @@
+#!/usr/bin/env bun