create-towns-protocol-app 0.0.189

package/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 River Association
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,54 @@
+# Create Towns Protocol App
+
+This package is used to scaffold a new React Towns Protocol app.
+
+## Templates
+
+### Playground Template
+
+By default, the script will create a new app using the Playground template: a full-featured example application.
+
+```bash
+yarn create towns-protocol-app my-app
+```
+
+### React Templates
+
+It will run `create-vite` to scaffold the project using either `react-ts` or `react` template.
+
+Then, it will install the necessary dependencies: `@towns-protocol/sdk` and `@towns-protocol/react-sdk`.
+
+Finally, it will add the `vite-plugin-node-polyfills` to the `vite.config.ts` file to ensure compatibility with Node.js native modules that are used by the Towns Protocol SDK.
+
+```bash
+yarn create towns-protocol-app my-app --template react-ts
+```
+
+## Usage
+
+You can use your preferred package manager to run the command.
+Example using `yarn`:
+
+```bash
+yarn create towns-protocol-app
+```
+
+This will create a new React Towns Protocol app in the current directory.
+
+If you want to create a new app in a different directory, you can specify the directory name as an argument:
+
+```bash
+yarn create towns-protocol-app my-app
+```
+
+You can specify a template using the `-t` or `--template` flag:
+
+```bash
+yarn create towns-protocol-app my-app --template react-ts
+```
+
+Available templates:
+
+- playground (default)
+- react-ts
+- react