https://github.com/revuls/luminis
Framework para crear web apps ligeras y modernas
https://github.com/revuls/luminis
Last synced: 16 days ago
JSON representation
Framework para crear web apps ligeras y modernas
- Host: GitHub
- URL: https://github.com/revuls/luminis
- Owner: revuls
- License: mit
- Created: 2025-05-17T14:44:43.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2026-02-22T15:56:19.000Z (5 months ago)
- Last Synced: 2026-07-16T17:36:48.424Z (16 days ago)
- Language: JavaScript
- Size: 1.36 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🌟 Luminis
**Luminis** is a Progressive Web App (PWA) built with [Lit](https://lit.dev/), [Vite](https://vitejs.dev/), and [Vaadin Router](https://vaadin.com/router). It's designed to be fast, modular, and scalable, with smooth navigation and clean styling.
---
## 🚀 Features
- ⚡️ Fast rendering with **LitElement**
- 🌐 SPA navigation with **Vaadin Router**
- 🎨 Global and scoped CSS styling
- 📱 Installable as a **PWA**
- 🌈 Smooth page transitions
- 🧭 Reusable navigation component
- 🌠 Built-in icon support with **Phosphor Icons**
---
## 🗂️ Project Structure
```
src/
├── assets/
│ ├── icons/ → Icons and logos
│ ├── styles/ → CSS styles folder
│ │ ├── global.css → Global styles
├── components/ → Lit components and pages
│ ├── pages/ → Lit pages
│ │ ├── home-page.js → Home page example
│ │ ├── about-page.js → About page example
│ │ ├── product-page.js → Product page example with route params
│ ├── shared/ → Shared Lit components
│ │ └── NavBar.js → Navigation component example
├── app.js → Main app entry point
├── router/index.js → Router configuration
├── index.html → Main HTML file
├── manifest.webmanifest → PWA manifest
├─ vite.config.js → Vite configuration
```
---
## 🌠 Icons
This project uses [@phosphor-icons/web](https://phosphoricons.com/) for its icon system. The icon web fonts are installed via npm and included in the main app entry.
**How to use an icon:**
```html
```
You can browse available icons at [https://phosphoricons.com/](https://phosphoricons.com/). Note that only the `regular` weight is imported by default in `src/app.js` to minimize bundle size, but others can be added if required.
---
## 🛠️ Requirements
- Node.js >= 18
- npm >= 8
---
## 📦 Installation
```bash
npm install
```
---
## 🧪 Development
```bash
npm run dev
```
This will start the app at [http://localhost:5173](http://localhost:5173).
---
## 🏗️ Production Build
```bash
npm run build
```
Optimized files will be generated in the `/dist` folder.
---
## 🔍 Preview Build
```bash
npm run serve
```
---
## 📱 PWA
This app includes a `manifest.webmanifest` and uses `vite-plugin-pwa` to:
- Add to home screen
- Work offline (optional Service Worker)
- Define name, icon, and theme colors
---
## 🧹 Linting & Formatting
```bash
npm run lint # Detect problems
npm run lint:fix # Auto-fix issues
npm run format # Format code with Prettier
```
---
## 📄 License
MIT License © 2025