⚡️ A lightning-fast, React-based website for generating QR codes built with Vite, React, Tailwind, and Shadcn UI.
- ✅ Instant QR Code generation
- 🎨 Clean, responsive UI
- 🧩 Built with React, Tailwind and Shadcn UI
- ⚡️ Powered by Vite for blazing fast dev experience
- 🧪 Tested with Vitest
1. Install Node.js
Make sure you have Node.js installed.
git clone https://github.com/mmarfat/qrisp
cd qrispnpm install --legacy-peer-deps
ℹ️ --legacy-peer-deps resolves potential peer dependency issues
npm run dev
Visit http://localhost:5173 in your browser to view the app.
To build and preview the app in production mode:
npm run build
npm run preview
We use Conventional Commits to keep our commit history clean and consistent.
| Type | Description |
|---|---|
feat |
A new feature |
fix |
A bug fix |
docs |
Documentation-only changes |
style |
Changes that do not affect the meaning of the code (e.g., formatting) |
refactor |
A code change that neither fixes a bug nor adds a feature |
perf |
A code change that improves performance |
test |
Adding missing tests or correcting existing ones |
chore |
Changes to the build process or auxiliary tools |
ci |
Changes to CI configuration files and scripts |
revert |
Reverts a previous commit |
Example:
feat: add dark mode toggle
- ⚛️ React
- ⚡ Vite
- 🎨 Tailwind CSS
- 🧱 Shadcn UI
- 📦 npm
- 🧪 Vitest
- 🧩 kozakdenys' QR Code Styling library
⛔ This is a personal project, so we’re not accepting general pull requests at the moment — however, localizations are always welcome!
If you have any suggestions or you want to report a bug please open an issue.
However, if you fork this repo and want to allow contributions we recommend the following approach:
First, clone the repository and checkout the dev branch:
git clone https://github.com/mmarfat/qrisp
cd qrisp
git checkout dev
Create a new branch from dev with an appropriate name (e.g., qr-generation-speedup or qr-generation-fix):
git checkout -b qr-generation-speedup
Implement changes on your branch.
Before creating a pull request, ensure your branch is up-to-date with the latest changes from dev. Follow these steps to sync:
First, checkout dev and pull the latest changes:
git checkout dev
git pull origin dev
Then, switch back to your feature branch and merge the changes from dev into your branch:
git checkout feature/new-feature
git merge dev
Resolve any conflicts that may occur.
Once your changes are ready and you've synced your branch with dev, create a pull request (PR) to merge your branch into the dev branch. The maintainer will review your PR and merge it if everything looks good.