Mocking up web app with Vital(speed)
Features
-
⚡️ React 17 -
🦾 TypeScript, of course -
🫀 Jest - unitary testing made easy -
🎨 Tailwind with JIT - next generation utility-first CSS -
🪢 CSS Modules -
👑 Atomic Design organization -
🗂 Absolute imports -
😃 Hero icons -
☁️ Deploy on Netlify, zero-config
Coding Style
Dev tools
- TypeScript
- Commit lint - helps your team adhering to a commit convention
- Netlify - zero-config deployment
Try it now!
GitHub Template
Create a repo from this template on GitHub.
Clone to local
If you prefer to do it manually with the cleaner git history
npx degit jvidalv/vital my-vital-app
cd my-vital-app
yarn # If you don't have yarn installed, run: npm install -g yarn
Checklist
When you use this template, try follow the checklist to update your info properly
- Rename
name
andauthor
fields inpackage.json
- Change the author name in
LICENSE
- Change the title in
index.html
- Change the favicon in
public
- Modify the manifest in
public
- Clean up the README's
And, enjoy :)
Usage
Development
Just run and visit http://localhost:3000
yarn start
Build
To build the App, run
yarn build
And you will see the generated file in dist
that ready to be served.
Deploy on Netlify
Go to Netlify and select your repository, OK
along the way, and your App will be live in a minute.
Issues
Husky
If pre-commit hooks are not working be sure that you have installed husky: husky install
.
By default this command should be triggered after yarn/npm deps are installed.
Why
I have created several React apps recently. Setting the configs up is kinda the bottleneck for me to make the ideas simply come true within a very short time.
So I made this starter template for myself to create apps more easily, along with some good practices that I have learned from making those apps. Feel free to tweak it or even maintains your own forks.
CSS within HTML
Hi there,
I'm wondering, there's atm no way to add CSS in HTML, is it possible to get that turned on/disable something to make that happen? I'm running a few queries in my CSS but somehow it is not catching the variables within .css files that I've defined in my tailwind.config.js
Updated Main.tsx to support React 18
Kept getting an error in the browser saying the project would only support React 17 without these changes. I figured since you went through all of the trouble of not only including, but advertising React 18, I made this change and now the browser doesn't complain.
Warnings @ install (eslint-plugin-react)
Run
yarn install
Warnings @ yarn start
After fresh install, run
yarn start