oddsdk/create-odd-app

A CLI generator for spinning up either React or SvelteKit versions of ODD templates with pre-configured auth flows

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

demo.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 running pnpm create odd-app
• --use-yarn - Explicitly tell the CLI to bootstrap the app using yarn. To bootstrap using pnpm we recommend running yarn 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

create-odd-app's Issues

Add option to remove TypeScript from the SvelteKit codebases(WAT, WalletAuth)

CRA and Next both allow you to generate non-TS versions of their codebases. It would be cool we could do the same. tsc, which was a transpiler that enabled this has been deprecated, but it may be worth investigating other solutions Scratch that, apparently tsc lives within the typescript package now. So i'm going to see if it's useable for this 👀

This has been implemented for the React codebases already, but we getting it working for SvelteKit is a bit trickier because I'll need to write a transpiler from scratch, so I've separated this into a separate issue than #2 👍🏼

Video ot supported on Firefox Dev Edition / macOS / M1

Was going to spend some time tire-kicking this morning, noticed the video on the readme for create-odd-app doesn't work:

Add option to remove TypeScript from the React codebases(WAT, WalletAuth)

CRA and Next both allow you to generate non-TS versions of their codebases. It would be cool we could do the same. tsc, which was a transpiler that enabled this has been deprecated, but it may be worth investigating other solutions Scratch that, apparently tsc lives within the typescript package now. So i'm going to see if it's useable for this 👀

Add option to remove gallery code from the selected codebase

Since all four webnative apps (https://github.com/webnative-examples/webnative-app-template, https://github.com/webnative-examples/webnative-app-template-react, https://github.com/webnative-examples/walletauth, https://github.com/webnative-examples/walletauth-react) are now using a DDD approach for the gallery code, we should add a prompt to this CLI to allow users to decide whether or not they want the gallery code included in the app they generate.

I think we should include the gallery code by default, simply because there isn't much else going on in the apps once the user has signed in, but it is likely many users will not want the gallery code included if they're using the generated templates to build other products.

Notes:
I think it's best to hold off on implementing this until after the 0.2 milestone has been completed, because there may be some UI updates and code shuffling done to the four templates as part of that

Replace fission pink and purple with new WAT colours

Use the new WAT orange in place of Fission's pink/purple in the CLI interface