-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #11 from omnisat/update
Update - Vue / Vanilla coming soon
- Loading branch information
Showing
2 changed files
with
75 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters