https://github.com/magiclabs/make-scoped-magic-app

https://github.com/magiclabs/make-scoped-magic-app

Last synced: about 1 year ago
JSON representation

• Host: GitHub
• URL: https://github.com/magiclabs/make-scoped-magic-app
• Owner: magiclabs
• License: mit
• Created: 2024-11-03T07:43:26.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2025-03-25T20:42:34.000Z (over 1 year ago)
• Last Synced: 2025-06-02T07:42:04.961Z (about 1 year ago)
• Language: TypeScript
• Size: 2.57 MB
• Stars: 1
• Watchers: 5
• Forks: 2
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

          
# 🪄 `make-scoped-magic-app`

> A tool for quickly scaffolding an app with Magic baked-in!



  License ·

  Contributing Guide



## 🚀 Usage

Getting started with the interactive scaffolding tool is easy. Just run the following command in your preferred shell:

```zsh

npx make-scoped-magic-app

```

Follow the interactive prompts to customize your project. Done! ✨

### Programmatic API

`make-scoped-magic-app` also supports a programmatic API, so you can generate boilerplate codes with Magic built-in from your own NodeJS scripts.

```ts

import makeScopedMagicApp from 'make-scoped-magic-app';

await makeScopedMagicApp({

  template: 'hello-world', // Same as --template, -t

  projectName: 'my-app',   // Same as --project-name, -p

  branch: 'master',        // Same as --branch, -b

  // The same, arbitrary data you can pass to a template via CLI flags.

  data: {

    publishableApiKey: 'pk_live_...',

    npmClient: 'yarn',

  }

})

```

See `npx make-scoped-magic-app --help` for information about the available options. In general, most CLI flags map to camel-cased properties in the configuration given to `makeScopedMagicApp({ ... })`.

For more information, you can print help text including template-specific options using `npx make-scoped-magic-app --help --template [i.e.: hello-world]`