|Light | Dark |
|--|--|
|
|
|
A **`high-contrast`**, **`minimalist`** foundation for **`building`** and distributing **`design systems`**. Engineered for technical **`speed`** and **`architectural clarity`**. Built with a **`clean`** modern tech stack featuring the latest **`libraries`** and **`frameworks`** for effortless, professional **`development`**.
## đ´ Badges
## ⨠Features
**`1.`** **âī¸ Atomic UI Components** - Modular components
**`2.`** **đ¨ Theme System** - Light/dark/system theme switching
**`3.`** **đą Responsive Design** - Mobile-first approach
**`4.`** **⥠Performance Optimized** - Lazy loading and code splitting
**`5.`** **âī¸ Configurable** - Feature toggles and customization
**`6.`** **đ TypeScript** - Full (some) type safety
**`7.`** **đĢ§ Minimalist** - Clean design
## đĒ¨ Quick Start
### âšī¸ Prerequisites
**`1.`** Node.js 18+
**`2.`** Bun or npm/yarn
### đŠ Installation
**`Option 1.`** Fresh Start (Recommended for custom projects)
> **Windows:**
```bash
git clone https://github.com/basalt3/spojt.git
cd spojt
# Clean up template files and start fresh
setup\clean.bat
bun install
bun run dev
```
> **Linux/macOS:**
```bash
git clone https://github.com/basalt3/spojt.git
cd spojt
# Clean up template files and start fresh
chmod +x setup/clean.sh
./setup/clean.sh
bun install
bun run dev
```
**`Option 2.`** Use Template As-Is
```bash
git clone https://github.com/basalt3/spojt.git
cd spojt
bun install
bun run dev
```
### âī¸ Configuration
The application **`behavior`** can be controlled through `src/resources/spojt.config.js` (if using the template as-is):
```javascript
// boolean values for visibility
export const spojtConfig = {
components: {
navbar: true,
hero: true,
libraries: true,
footer: true,
},
utilities: {
themeSwitcher: true,
matrixFx: true,
autoScroll: false,
highlighter: true,
},
};
```
## đ Featuring
**`1.`** [Shadcn UI](https://ui.shadcn.com/) - Components and utilities
**`2.`** [Phosphor Icons](https://phosphoricons.com/) - Icon library
**`3.`** [Once UI](https://once-ui.com/) - Design system foundation created by [this guy đ¤¯](https://github.com/lorant-one)
**`4.`** [JSrepo](https://www.jsrepo.dev/) - JavaScript configuration library
**`5.`** [Tailwind CSS](https://tailwindcss.com/) - Utility styling
> And now that's...... _**`s-p-o-j-t`**_ â¨
## đ¯ License
**`đĒĒ MIT License`**- see [LICENSE](LICENSE) file for details.