2022-07-07 02:32:19 +00:00
# Vite RiotJS Template
Use [Vite ](https://vitejs.dev/ ) Starter Template to scaffold a new [Riot ](https://riot.js.org/ ) project.
2022-07-18 04:19:13 +00:00
2022-07-07 02:32:19 +00:00
## 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
2022-07-07 02:34:10 +00:00
```
2022-07-07 02:32:19 +00:00
2022-07-28 22:47:01 +00:00
### 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
2023-03-15 12:36:13 +00:00
2022-07-28 22:47:01 +00:00
### Project Structure
```
dist/ < -- `npm run build` app
src/ < -- your source code
css/ < -- processed css files
js/ < -- processed javascript files
public/ < -- unprocessed static `/` assets
2022-07-29 04:14:19 +00:00
components/ < -- riots components
2023-03-15 12:36:13 +00:00
hello-riot.riot < -- example riot component
2023-03-02 19:29:00 +00:00
app.js < -- app initialization
2022-07-28 22:47:01 +00:00
index.html < -- START HERE
vite.config.js < -- build configuration
README.md
... < -- misc project meta files
```
2023-03-15 12:36:13 +00:00
### Automatic Tag Registeration
2022-07-18 04:19:13 +00:00
2023-03-15 12:36:13 +00:00
Any `.riot` components under the `src/` directory are automatically registered, like `components/` . You can add, rename, restructure the folders as you like.
2022-07-18 04:19:13 +00:00
2023-03-02 19:29:00 +00:00
> SEE: `/src/app.js` for more information
2022-07-29 02:45:51 +00:00
2022-07-18 04:19:13 +00:00
2022-07-07 02:32:19 +00:00
## NPM Scripts
2023-03-15 12:36:13 +00:00
- `npm run dev` - Starts the development server at port 5173
2022-07-29 02:45:51 +00:00
- `npm run build` - Builds the application in a dist folder
2023-03-15 12:37:55 +00:00
- `npm run preview` - Serves the build files (dist folder) locally at port 4173
2022-07-07 02:32:19 +00:00
2023-03-15 12:36:13 +00:00
> See [ViteJS Documentation](https://vitejs.dev/) for more information
2022-07-07 02:32:19 +00:00
2022-07-18 04:19:13 +00:00
2022-07-07 02:32:19 +00:00
## License
2022-07-18 03:53:56 +00:00
- [MIT License ](https://github.com/n2geoff/vite-riot-template/blob/main/LICENSE ).