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
riotjs development template using vite
50 Commits 1 Branch 9 Tags 169 KiB
Riot 63.6%
JavaScript 20.8%
CSS 8.1%
HTML 7.5%
Go to file
Geoff Doty fa78a99f55 readme 2024-09-01 11:49:59 -04:00
src add routing 2024-09-01 11:45:46 -04:00
.gitignore initial commit 2022-07-06 22:32:19 -04:00
LICENSE initial commit 2022-07-06 22:32:19 -04:00
README.md readme 2024-09-01 11:49:59 -04:00
index.html major refactor 2024-07-29 21:31:16 -04:00
package-lock.json add routing 2024-09-01 11:45:46 -04:00
package.json add routing 2024-09-01 11:45:46 -04:00
vite.config.js major refactor 2024-07-29 21:31:16 -04:00

README.md

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 5.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
src/                                <-- your source code
    css/                            <-- processed css files
    js/                             <-- processed javascript files
    public/                         <-- unprocessed static `/` assets
    components/                     <-- riots components examples
        riot-welcome.riot
        riot-about.riot
    main.js                         <-- main app initialization
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