olrtg/venus

Opinionated Vite starter template for modern React development.

Venus

Opinionated Vite starter template for modern React development.

📦 Features

• ⚡️ React, Vite, pnpm - always fast
• 🗂 File based routing
• 📱 PWA
• 🎨 Tailwind CSS
• 😄 Use icons from any icon sets, zero compromises
• 📄 Markdown support
• 📥 APIs auto importing - use react, react-router-dom and icons directly
• 💪 Typescript, of course
• ☁️ Deploy on Netlify, zero-config
• 🪆 File nesting config for Visual Studio Code

🚀 Quick start

Venus requires Node >= 14

Github template

Create a repo from this template

Clone to local

If you rather prefer a clean git history

npx degit olrtg/venus my-venus-app

cd my-venus-app

pnpm i

If you don't have pnpm installed, run: npm i -g pnpm

⚙️ Usage

Development

Just run the commmand below and visit localhost:3000

pnpm dev

Build

To build de App, run

pnpm build

And you will see the generated files in dist/ ready to be served.

Deploy on Netlify

Go to Netlify and select your clone, OK along the way, and your App will be live in a minute.

🙏 Credits

• This project was heavily inspired by antfu/vitesse.
• Venus logo from Flaticon, created by Freepik