mast/mast-react/README.md

31 lines
1.1 KiB
Markdown
Raw Normal View History

2024-10-26 00:00:30 -07:00
# vite-starter
Getting started with pnpm/npm/yarn create:
```
# npm
npm create @vlcn.io@latest your-app-name
# pnpm
pnpm create @vlcn.io your-app-name
# yarn
yarn create @vlcn.io your-app-name
```
Or, just cloning directly:
```
git clone git@github.com:vlcn-io/vite-starter.git
npm install
npm dev
```
What you get:
- A client ([App.tsx](https://github.com/vlcn-io/vite-starter/blob/main/src/App.tsx)) that runs a SQLite DB
- A server ([server.js](https://github.com/vlcn-io/vite-starter/blob/main/server.js)) that the client (or many clients) can sync to when online
- A database schema file ([schemas/main.mjs](https://github.com/vlcn-io/vite-starter/blob/main/src/schemas/main.mjs) that is automatically migrated to (auto migration is still in beta! You may find yourself needing to wipe the DB (clear indexeddb or change dbid) when using auto-migrate) on server and client restart.
Demo Video: [![example scaffolding result](https://img.youtube.com/vi/QJBQLYmXReI/0.jpg)](https://www.youtube.com/watch?v=QJBQLYmXReI)
Deployed Scaffolding: https://vite-starter2.fly.dev/ Try it out! Collaborate between all your devices.