Explore the docs »
View Demo · Report Bug · Request Feature
Table of Contents
This repository contains... [ Briefly describe your project in 1-2 sentences. ]
Here's what you'll find:
- ✨ Tailwind CSS with Lightning CSS support
- 🧰 React components with Shadcn
- 🤖 Cloudflare Adapter with Wrangler tools
Ready to get started?
- [Link to Documentation/Getting Started Guide]
- [Link to Example Usage]
Let's build something amazing! 👍
This section should list any major frameworks/libraries used to run this project.
This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.
This is an example of how to list things you need to use the software and how to install them.
-
npm
npm install -g bun # the last `npm` command you'll ever need
Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.
-
Get a free template at https://shadowbun.pages.dev
-
Or Clone the repo
git clone https://github.com/Frikadellios/shadowbun.git
-
Install NPM packages
bun install
-
Enter your ENV_SECRETS in
.envand use .env.example SECRETS for Cloudflare deployment or if you use Wrangler for itAPI_KEY = 'ENTER YOUR API';
-
Run Development mode:
bun run start
Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.
For more examples, please refer to the Documentation
- Add Changelog
- Add back to top links
- Add Additional Templates w/ Examples
- Add "components" document to easily copy & paste sections of the readme
- Multi-language Support
- Chinese
- Spanish
- Ukrainian
- German
- Itallian
See the open issues for a full list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Distributed under the MIT License. See LICENSE.txt for more information.
Creator - Frikadellios
Project Link: ShadowBun
Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!