https://github.com/iamdyeus/shadcn-vite-javascript-boilerplate

Boiler Plate to begin with Shadcn in VITE with only Javascript (No TypeScript)
https://github.com/iamdyeus/shadcn-vite-javascript-boilerplate

Last synced: 2 months ago
JSON representation

Boiler Plate to begin with Shadcn in VITE with only Javascript (No TypeScript)

• Host: GitHub
• URL: https://github.com/iamdyeus/shadcn-vite-javascript-boilerplate
• Owner: iamDyeus
• License: mit
• Created: 2024-07-10T12:26:35.000Z (11 months ago)
• Default Branch: master
• Last Pushed: 2024-10-16T17:14:06.000Z (8 months ago)
• Last Synced: 2024-10-18T11:00:41.657Z (8 months ago)
• Language: JavaScript
• Size: 379 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Shadcn VITE Boilerplate

A boilerplate to kickstart your project using Shadcn in VITE with pure JavaScript (No TypeScript). This setup provides a robust foundation for developing modern web applications with an optimized build process and development environment.

## Features

- VITE for fast builds and hot module replacement

- Shadcn for component styling and theming

- Pure JavaScript for simplicity and ease of use

- Demo dashboard that works with react-router-dom

- Mode toggle, which supports dark & light mode

## Installation

To get started with this boilerplate, follow these steps:

1. **Clone the repository:**

   ```bash

   git clone https://github.com/iamDyeus/shadcn-vite-javascript-boilerplate.git

   ```

2. **Navigate to the project directory:**

   ```bash

   cd shadcn-vite-javascript-boilerplate

   ```

3. **Install dependencies:**

   ```bash

   npm install

   ```

4. **Run the development server:**

   ```bash

   npm run dev

   ```

5. **Build the project for production:**

   ```bash

   npm run build

   ```

## Demo

Here's a screenshot of the current template dashboard:

![Template Dashboard Dark Theme](public/demoImageDark.png)

![Template Dashboard Light Theme](public/demoImageLight.png)

## Contributing

Contributions are welcome! If you have any ideas or suggestions to improve this boilerplate, feel free to open an issue or submit a pull request.

## License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.

## Acknowledgements

- [VITE](https://vitejs.dev/)

- [Shadcn](https://ui.shadcn.com/)

---

Happy coding!