Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/open-sorcerer/sol-blinker
https://github.com/open-sorcerer/sol-blinker
Last synced: 6 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/open-sorcerer/sol-blinker
- Owner: Open-Sorcerer
- License: mit
- Created: 2024-07-14T12:48:03.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-07-14T14:27:04.000Z (4 months ago)
- Last Synced: 2024-09-17T07:29:20.804Z (2 months ago)
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/sol-blinker
- Size: 17.6 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: Readme.md
- License: LICENSE
Awesome Lists containing this project
README
# sol-blinker
A beautiful command-line interface tool for installing Solana Blinks project templates.
[](https://www.npmjs.com/package/sol-blinker)
## Usage
You can use sol-blinker without installing it by using npx:
```bash
npx sol-blinker create
```
This command will download and execute sol-blinker, prompting you to select a framework and set up your project.
## Installation (Optional)
If you prefer, you can install sol-blinker globally using npm:
```bash
npm install -g sol-blinker
```
After installation, you can use the CLI tool directly:
```bash
sol-blinker create
```
## Available Commands
- `npx sol-blinker create`: Create a new Solana Blinks project
- `npx sol-blinker --help`: Display help information
- `npx sol-blinker create --help`: Display help for the create command
If you've installed sol-blinker globally, you can use the same commands without `npx`.
## Available Templates
- NextJS: A NextJS template for Solana Blinks projects
- Express: An Express template for Solana Blinks projects
- Axum (Rust): An Axum template for Solana Blinks projects
More templates will be added in future updates.
## Contributing
Contributions are welcome! Here are some ways you can contribute to this project:
- Add new project templates
- Improve existing templates
- Enhance CLI functionality
- Report bugs and suggest features
To contribute:
1. Fork the repository
2. Create your feature branch: `git checkout -b feature/my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin feature/my-new-feature`
5. Submit a pull request
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Acknowledgments
- Thanks to the Solana community for inspiration and support
## Support
If you're having any problem, please [raise an issue](https://github.com/Open-Sorcerer/sol-blinker/issues/new) on GitHub.
## Stay in touch
- Twitter - [@0xharsh1001](https://x.com/0xharsh1001)