Skip to content

Commit

Permalink
Merge pull request #11 from omnisat/update
Browse files Browse the repository at this point in the history
Update - Vue / Vanilla coming soon
  • Loading branch information
0xBunzy authored Nov 17, 2024
2 parents b58515d + 912c29d commit 77666ea
Show file tree
Hide file tree
Showing 2 changed files with 75 additions and 14 deletions.
72 changes: 65 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,76 @@
<!-- @format -->

# create-lasereyes

Interactive CLI tool to scaffold Next.js projects with LaserEyes integration to quickly start building Bitcoin Apps.

## Usage
## Quick Start

```bash
npx create-lasereyes
```

## Features

- Creates a Next.js project
- Integrates LaserEyes
- Optional Tailwind CSS setup
- Optional Shadcn UI components
- ⚡️ **Next.js Integration** - Creates a modern Next.js project with App Router using React 18
- 🔐 **LaserEyes Wallet Connect Modal** - Pre-configured Bitcoin wallet integration
- 🎨 **Styling**
- Shadcn / Tailwind CSS setup
- Light / Dark Mode App Toggle
- 🚀 **Best Practices**
- TypeScript by default
- ESLint configuration
- Optimized project structure

## Project Structure

After running the command, your project will include:

```
src/
├── app/
│ ├── favicon.ico
│ ├── globals.css
│ ├── layout.tsx # Root layout with providers
│ └── page.tsx # Home page
├── components/
│ ├── ui/ # Reusable Shadcn UI Components
│ ├── ConnectWallet.tsx # LaserEyes Wallet Connection Modal
│ ├── DefaultLayout.tsx # LaserEyes Provider Wrapper
│ └── ThemeToggle.tsx # Light/Dark Mode Toggle
└── lib/
└── utils.ts
```

## Development

1. Create a new project:

```bash
npx create-lasereyes
```

2. Follow the interactive prompts to customize your setup

3. Navigate to your project:

```bash
cd your-project-name
```

4. Start developing:
```bash
npm run dev
```

## Coming Soon

- Vue.js template support
- Vanilla JavaScript template
- Additional wallet integrations

## Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

## License

MIT License - feel free to use this in your own projects!
17 changes: 10 additions & 7 deletions src/frameworks.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,14 @@ export interface Framework {
display: string;
color: (str: string) => string;
variants?: Variant[];
disabled?: boolean;
}

export const frameworks: Framework[] = [
{
name: "react",
display: "React",
color: pc.blue,
color: pc.green,
variants: [
{
name: "next-app",
Expand All @@ -29,25 +30,27 @@ export const frameworks: Framework[] = [
},
{
name: "vue",
display: "Vue",
color: pc.green,
display: "Vue: Coming Soon",
color: pc.gray,
disabled: true,
variants: [
{
name: "vue-app",
display: "Vue 3 + Vite",
color: pc.green,
color: pc.gray,
},
],
},
{
name: "vanilla",
display: "Vanilla",
color: pc.yellow,
display: "Vanilla: Coming Soon",
color: pc.gray,
disabled: true,
variants: [
{
name: "vite-vanilla",
display: "Vite",
color: pc.yellow,
color: pc.gray,
},
],
},
Expand Down

0 comments on commit 77666ea

Please sign in to comment.