https://github.com/n2geoff/vite-riot-template
riotjs development template w/ routing and using vite
https://github.com/n2geoff/vite-riot-template
degit riotjs routing spa template vitejs
Last synced: 2 months ago
JSON representation
riotjs development template w/ routing and using vite
- Host: GitHub
- URL: https://github.com/n2geoff/vite-riot-template
- Owner: n2geoff
- License: mit
- Created: 2022-07-07T02:30:36.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-03-22T22:17:07.000Z (3 months ago)
- Last Synced: 2025-03-22T23:20:51.626Z (3 months ago)
- Topics: degit, riotjs, routing, spa, template, vitejs
- Language: Riot
- Homepage:
- Size: 219 KB
- Stars: 7
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Vite RiotJS Template
Use [Vite](https://vitejs.dev/) Starter Template to scaffold a new [Riot](https://riot.js.org/) project.
## Features
Minimal SPA setup using
- Riot 9.x
- Route 9.x
- Vite 6.x
## Getting Started
Pull the template files with [degit](https://github.com/Rich-Harris/degit) and install dependencies
```
npx degit n2geoff/vite-riot-template my-project
cd my-project
npm install
npm run dev
```
### Checklist
When you use this template, you should update the following with your information
- [ ] Update `package.json` information
- [ ] Change the author name in `LICENSE`
- [ ] Change the favicon in `public`
- [ ] Clean up the README
### Project Structure
```
dist/ <-- `npm run build` app
app/ <-- your app code
css/ <-- processed css files
js/ <-- processed javascript files
public/ <-- unprocessed static `/` assets
components/ <-- riots components
app.riot
pages/ <-- semantic page/components
riot-welcome.riot
riot-about.riot
boot.js <-- app bootstrap
index.html <-- START HERE
vite.config.js <-- build configuration
README.md
... <-- misc project meta files
```
## NPM Scripts
- `npm run dev` - Starts the development server at port 5173
- `npm run build` - Builds the application in a dist folder
- `npm run preview` - Serves the build files (dist folder) locally at port 4173
> See [ViteJS Documentation](https://vitejs.dev/) for more information
## License
- [MIT License](https://github.com/n2geoff/vite-riot-template/blob/main/LICENSE).