Skip to content

chore: rename create-solana-dapp -> create-poc #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .changeset/config.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"changelog": [
"@changesets/changelog-github",
{
"repo": "solana-developers/create-solana-dapp"
"repo": "samui-build/create-poc"
}
],
"commit": false,
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/e2e-test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
45 changes: 1 addition & 44 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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
14 changes: 7 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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:

Expand Down Expand Up @@ -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:

Expand Down Expand Up @@ -95,20 +95,20 @@ 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:

```shell
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
Expand Down
4 changes: 2 additions & 2 deletions MAINTAINERS.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Maintaining create-solana-dapp
# Maintaining create-poc

The document has information for the maintainers of this package.

Expand All @@ -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.
Expand Down
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
# create-solana-dapp
# create-poc

:zap: Get up and running fast with Solana dApps :zap:

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).

Expand All @@ -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 <github-org>/<github-repo>
npm create poc@latest -t <github-org>/<github-repo>

# pnpm
pnpm create solana-dapp@latest -t <github-org>/<github-repo>
pnpm create poc@latest -t <github-org>/<github-repo>

# yarn
yarn create solana-dapp -t <github-org>/<github-repo>
yarn create poc -t <github-org>/<github-repo>
```

## Init script
Expand All @@ -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:",
Expand Down Expand Up @@ -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
```
Expand Down
14 changes: 7 additions & 7 deletions package.json
Original file line number Diff line number Diff line change
@@ -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,
Expand All @@ -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"
Expand Down
32 changes: 16 additions & 16 deletions csd.sh → poc.sh
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/utils/init-script-schema.ts
Original file line number Diff line number Diff line change
@@ -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())

Expand Down