diff --git a/.changeset/config.json b/.changeset/config.json index 211a4ba..33ffa3e 100644 --- a/.changeset/config.json +++ b/.changeset/config.json @@ -5,7 +5,7 @@ "changelog": [ "@changesets/changelog-github", { - "repo": "solana-developers/create-solana-dapp" + "repo": "samui-build/create-poc" } ], "commit": false, diff --git a/.github/workflows/e2e-test.yml b/.github/workflows/e2e-test.yml index 77e4e0b..83efdaa 100644 --- a/.github/workflows/e2e-test.yml +++ b/.github/workflows/e2e-test.yml @@ -67,7 +67,7 @@ jobs: yarn) npm install -g yarn;; esac - - name: Create and Build using create-solana-dapp + - name: Create and Build using create-poc run: | TEMP_DIR=$(mktemp -d) cd "$TEMP_DIR" diff --git a/CHANGELOG.md b/CHANGELOG.md index 94144c5..f72b606 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,44 +1 @@ -# create-solana-dapp - -## 4.3.2 - -### Patch Changes - -- [#164](https://github.com/solana-developers/create-solana-dapp/pull/164) - [`dde3428`](https://github.com/solana-developers/create-solana-dapp/commit/dde3428b7236bbe73fecb1016cfa1c21b0996f0c) - Thanks [@beeman](https://github.com/beeman)! - add build step to publish-packages workflow - -## 4.3.1 - -### Patch Changes - -- [#162](https://github.com/solana-developers/create-solana-dapp/pull/162) - [`f833848`](https://github.com/solana-developers/create-solana-dapp/commit/f833848bd6623ada20b67c776ffbe6cbfac035e4) - Thanks [@beeman](https://github.com/beeman)! - remove 'concurrency' parameter from build-step-decider - -## 4.3.0 - -### Minor Changes - -- [#140](https://github.com/solana-developers/create-solana-dapp/pull/140) - [`55969f0`](https://github.com/solana-developers/create-solana-dapp/commit/55969f0ae96f3f427623007ca56e07c0cb113949) - Thanks [@beeman](https://github.com/beeman)! - Update framework descriptions and structure - -- [#159](https://github.com/solana-developers/create-solana-dapp/pull/159) - [`c51ef37`](https://github.com/solana-developers/create-solana-dapp/commit/c51ef37e40b27d7f16a28f1e0d30823afec10d8a) - Thanks [@tobeycodes](https://github.com/tobeycodes)! - add bun support - -### Patch Changes - -- [#156](https://github.com/solana-developers/create-solana-dapp/pull/156) - [`d60c5cf`](https://github.com/solana-developers/create-solana-dapp/commit/d60c5cffb2791cbb619997b09c2fdb9dcb4faeb5) - Thanks [@beeman](https://github.com/beeman)! - add more examples to csd.sh - -- [#160](https://github.com/solana-developers/create-solana-dapp/pull/160) - [`d50c791`](https://github.com/solana-developers/create-solana-dapp/commit/d50c7911afaa1260349ab6f1c86b7269cd221611) - Thanks [@beeman](https://github.com/beeman)! - enable gill-next-tailwind-basic and gill-next-tailwind-counter - templates - -- [#144](https://github.com/solana-developers/create-solana-dapp/pull/144) - [`813773d`](https://github.com/solana-developers/create-solana-dapp/commit/813773d48bf06d9f4b3b2d27e09dbd772b24613e) - Thanks [@beeman](https://github.com/beeman)! - clean up init script utils +# create-poc diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b3cfbe2..576fd57 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,4 @@ -# Contributing to create-solana-dapp +# Contributing to create-poc We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's: @@ -28,10 +28,10 @@ Pull requests are the best way to propose changes to the codebase. We actively w In short, when you submit code changes, your submissions are understood to be under the same [MIT License](https://choosealicense.com/licenses/mit/) that covers the project. -## Report bugs using GitHub's [issues](https://github.com/solana-developers/create-solana-dapp/issues) +## Report bugs using GitHub's [issues](https://github.com/samui-build/create-poc/issues) We use GitHub issues to track public bugs. Report a bug by -[opening a new issue](https://github.com/solana-developers/create-solana-dapp/issues/new); it's that easy! +[opening a new issue](https://github.com/samui-build/create-poc/issues/new); it's that easy! **Great Bug Reports** tend to have: @@ -95,7 +95,7 @@ pnpm lint If you want to quickly test your changes to the CLI, you can do the following: -#### create-solana-dapp +#### create-poc Run the build in watch mode in one terminal: @@ -103,12 +103,12 @@ Run the build in watch mode in one terminal: pnpm build:watch ``` -In another terminal, move to the directory where you want to test the `create-solana-dapp` CLI and run by invoking the -`node` command with the path to the compiled CLI: +In another terminal, move to the directory where you want to test the `create-poc` CLI and run by invoking the `node` +command with the path to the compiled CLI: ```shell cd /tmp -node ~/path/to/create-solana-dapp/dist/bin/index.cjs --help +node ~/path/to/create-poc/dist/bin/index.cjs --help ``` ### Committing Your Changes diff --git a/MAINTAINERS.md b/MAINTAINERS.md index bae4b15..4862975 100644 --- a/MAINTAINERS.md +++ b/MAINTAINERS.md @@ -1,4 +1,4 @@ -# Maintaining create-solana-dapp +# Maintaining create-poc The document has information for the maintainers of this package. @@ -21,7 +21,7 @@ version. ## Publishing new versions -New versions of `create-solana-dapp` are published via the GitHub Actions CI/CD. +New versions of `create-poc` are published via the GitHub Actions CI/CD. When a PR is merged to the `main` branch, a canary release will be published and tagged with `canary` with all the merged changes. diff --git a/README.md b/README.md index cf1038a..3fb9379 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# create-solana-dapp +# create-poc :zap: Get up and running fast with Solana dApps :zap: @@ -6,17 +6,17 @@ Just run one simple command to generate a new project! ```shell # npm -npm create solana-dapp@latest +npm create poc@latest # pnpm -pnpm create solana-dapp@latest +pnpm create poc@latest # yarn (only supports the 'latest' tag) -yarn create solana-dapp +yarn create poc ``` -[![npm version](https://img.shields.io/npm/v/create-solana-dapp?color=yellow)](https://npmjs.com/package/create-solana-dapp) -[![npm downloads](https://img.shields.io/npm/dm/create-solana-dapp?color=yellow)](https://npmjs.com/package/create-solana-dapp) +[![npm version](https://img.shields.io/npm/v/create-poc?color=yellow)](https://npmjs.com/package/create-poc) +[![npm downloads](https://img.shields.io/npm/dm/create-poc?color=yellow)](https://npmjs.com/package/create-poc) This is a CLI that automates the initialization of predefined Solana templates (see below). @@ -27,19 +27,19 @@ The official `create-solana-dapp` templates can be found in ## External templates -You can also use `create-solana-dapp` to create projects using external templates: +You can also use `create-poc` to create projects using external templates: The `--template` (or `-t`) flag supports anything that [giget](https://github.com/unjs/giget) supports ```shell # npm -npm create solana-dapp@latest -t / +npm create poc@latest -t / # pnpm -pnpm create solana-dapp@latest -t / +pnpm create poc@latest -t / # yarn -yarn create solana-dapp -t / +yarn create poc -t / ``` ## Init script @@ -52,7 +52,7 @@ in the project. ```jsonc { "name": "your-template", - "create-solana-dapp": { + "create-poc": { // These instructions will be returned to the user after installation "instructions": [ "Run Anchor commands:", @@ -96,8 +96,8 @@ Contributions are welcome! Please see [CONTRIBUTING.md](./CONTRIBUTING.md) for m To install the project locally, run the following commands: ```shell -git clone https://github.com/solana-developers/create-solana-dapp.git -cd create-solana-dapp +git clone https://github.com/samui-build/create-poc.git +cd create-poc pnpm install pnpm build ``` diff --git a/package.json b/package.json index dd21f77..eac2f9d 100644 --- a/package.json +++ b/package.json @@ -1,15 +1,15 @@ { - "name": "create-solana-dapp", - "version": "4.3.2", + "name": "create-poc", + "version": "0.0.0", "description": "Get up and running fast with Solana dApps", "repository": { - "name": "solana-developers/create-solana-dapp", + "name": "samui-build/create-poc", "type": "git", - "url": "https://github.com/solana-developers/create-solana-dapp" + "url": "https://github.com/samui-build/create-poc" }, - "homepage": "https://github.com/solana-developers/create-solana-dapp#readme", + "homepage": "https://github.com/samui-build/create-poc#readme", "bugs": { - "url": "https://github.com/solana-developers/create-solana-dapp/issues" + "url": "https://github.com/samui-build/create-poc/issues" }, "license": "MIT", "sideEffects": false, @@ -28,7 +28,7 @@ "module": "./dist/index.mjs", "types": "./dist/index.d.ts", "bin": { - "create-solana-dapp": "./dist/bin/index.cjs" + "create-poc": "./dist/bin/index.cjs" }, "files": [ "dist" diff --git a/csd.sh b/poc.sh similarity index 66% rename from csd.sh rename to poc.sh index 4f448f5..b5976e2 100755 --- a/csd.sh +++ b/poc.sh @@ -1,38 +1,38 @@ #!/usr/bin/env bash # -# csd.sh - Wrapper around create-solana-dapp to make it easier to use during development +# poc.sh - Wrapper around create-poc to make it easier to use during development # -# These examples assume you have a symlink this script to a location in your PATH, like ~/.local/bin/csd or ~/bin/csd -# $ ln -s $HOME/path/to/create-solana-dapp/csd.sh ~/.local/bin/csd +# These examples assume you have a symlink this script to a location in your PATH, like ~/.local/bin/poc or ~/bin/poc +# $ ln -s $HOME/path/to/create-poc/poc.sh ~/.local/bin/poc # or -# $ ln -s $HOME/path/to/create-solana-dapp/csd.sh ~/bin/csd +# $ ln -s $HOME/path/to/create-poc/poc.sh ~/bin/poc # # Create an app using the default prompts and a random unique name: -# $ csd +# $ poc # # Create an app using a template and a random unique name: -# $ csd gh:solana-developers/solana-templates/templates/template-node-express +# $ poc gh:samui-build/samui-templates/templates/template-node-express # # Create an app using a template and a specific name: -# $ csd gh:solana-developers/solana-templates/templates/template-node-express my-api +# $ poc gh:samui-build/samui-templates/templates/template-node-express my-api # # Create an app using a template from a pull request number 35 (must be an active or recent PR): -# $ csd gh:solana-developers/solana-templates/templates/template-node-express#refs/pull/35/merge +# $ poc gh:samui-build/samui-templates/templates/template-node-express#refs/pull/35/merge # -# Create an app using create-solana-dapp@next -# $ TAG=next csd +# Create an app using create-poc@next +# $ TAG=next poc # -# Create an app using a local create-solana-dapp command. Run `pnpm build:watch` in the create-solana-dapp directory to watch for changes. -# $ CMD="node $HOME/path/to/create-solana-dapp/dist/bin/index.cjs --pnpm" csd +# Create an app using a local create-poc command. Run `pnpm build:watch` in the create-poc directory to watch for changes. +# $ CMD="node $HOME/path/to/create-poc/dist/bin/index.cjs --pnpm" poc # # Create an app using npx -# $ CMD="npx -y create-solana-dapp@latest" csd +# $ CMD="npx -y create-poc@latest" poc # # Create an app using yarn -# $ CMD="yarn create solana-dapp" csd +# $ CMD="yarn create poc" poc # # TODO: -# - add support for PARAMS env var to pass additional parameters to create-solana-dapp, like --pnpm or --skip-install +# - add support for PARAMS env var to pass additional parameters to create-poc, like --pnpm or --skip-install # - add parameters or env vars to controll package manager # Set defaults for bash @@ -45,7 +45,7 @@ if [[ -z "${TAG+x}" ]]; then TAG="latest" fi -# Check if the CMD is already set in the environment, otherwise use default "create-solana-dapp" +# Check if the CMD is already set in the environment, otherwise use default "create-poc" if [[ -z "${CMD+x}" ]]; then CMD=("pnpm" "create" "solana-dapp@${TAG}") else diff --git a/src/utils/init-script-schema.ts b/src/utils/init-script-schema.ts index bfd24e0..fce0ec5 100644 --- a/src/utils/init-script-schema.ts +++ b/src/utils/init-script-schema.ts @@ -1,7 +1,7 @@ import { z } from 'zod' // This is the key used in package.json to store the init script -export const initScriptKey = 'create-solana-dapp' +export const initScriptKey = 'create-poc' export const InitScriptSchemaInstructions = z.array(z.string())