@oddjs/create-odd-app
v0.0.15
Published
Create ODD apps in either React or SvelteKit with a single command.
Downloads
21
Readme
Create ODD App (COA)
CWA is a CLI generator that allows you to spin up either React or SvelteKit flavours of Fission's ODD App Template and ODD WalletAuth repos.
🎬 Demo
https://user-images.githubusercontent.com/1179291/195956380-8c1442fa-75d9-4167-8e0f-b8660d40e149.mp4
💻 Getting Started
You can use the following commands via your package manager of choice to invoke create-odd-app
npx @oddjs/create-odd-app
Options
You can invoke create-odd-app
directly with an app name or you can wait to be prompted to set one:
npx @oddjs/create-odd-app my-odd-app
create-odd-app
also comes with the following options:
- --use-sveltekit - Explicitly tell the CLI to build the application using SvelteKit
- --use-react - Explicitly tell the CLI to build the application using React
- --use-walletauth - Explicitly tell the CLI to build the application using the ODD WalletAuth flow
- --use-webcrypto - Explicitly tell the CLI to build the application using the ODD Device Linking flow
- --use-npm - Explicitly tell the CLI to bootstrap the app using
npm
. This is the default option. - --use-pnpm - Explicitly tell the CLI to bootstrap the app using
pnpm
. To bootstrap using pnpm we recommend runningpnpm create odd-app
- --use-yarn - Explicitly tell the CLI to bootstrap the app using
yarn
. To bootstrap using pnpm we recommend runningyarn create odd-app
🤔 What's The ODD SDK?
The ODD SDK empowers developers to build fully distributed web applications without needing a complex back-end. The SDK provides:
- user accounts (via the browser's Web Crypto API),
- authorization (using UCAN)
- encrypted file storage (via the ODD File System, backed by the InterPlanetary File System, or IPFS)
- and key management (via websockets and a two-factor auth-like flow).
ODD applications work offline and store data encrypted for the user by leveraging the power of the web platform. You can read more about the ODD SDK in Fission's ODD Guide.
🚀 Contributing
git clone [email protected]:oddsdk/create-odd-app.git
cd create-odd-app
nvm use
npm i
npm run dev