geoff
/
vite-riot-template
mirror of https://github.com/n2geoff/vite-riot-template.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
vite-riot-template/README.md

1.8 KiB
Raw Blame History

Vite RiotJS Template

Use Vite Starter Template to scaffold a new Riot project.

Features

Minimal SPA setup using

  • Riot 9.x
  • Route 9.x
  • Vite 6.x

Getting Started

Pull the template files with 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 for more information

License