Skip to content

MakeRedundant/Business_Card-Generator

Repository files navigation

Business Card Generator

Simple Business Card Generator with a live preview and option to download the card in png format.
https://business-cards-generator.netlify.app

Github licence JavaScript Badge Font Awesome downloadjs html-to-image million mini-css-extract-plugin react react-dom react-scripts react-tilt styled-components web-vitals @craco/craco @types/react @types/react-dom @vitejs/plugin-react eslint eslint-plugin-react eslint-plugin-react-hooks eslint-plugin-react-refresh vite Netlify Status

📓 Table of Contents

💡🏡 Lighthouse

This is the Lighthouse Google report showcasing Performance 🚀, Accessibility ♿️, Best practices ✅, and SEO 🔍.

Lighthouse

📄 Description

Contains About Me, Experience, Skills, Projects, Contact, Resume, Email, Footer
also contains bad humour!

🪛 Technologies used

Technology Description Link
Node.js Server-side JavaScript runtime Node.js
NPM Node.js Package Manager NPM
Font Awesome Icon set and toolkit Font Awesome
downloadjs File downloading utility downloadjs
html-to-image HTML to image conversion html-to-image
million Large number formatting million
mini-css-extract-plugin Webpack plugin for extracting CSS mini-css-extract-plugin
react JavaScript library for building UIs react
react-dom React rendering for the DOM react-dom
react-scripts Create React App scripts react-scripts
react-tilt React component for tilting elements react-tilt
styled-components CSS-in-JS library for styling styled-components
web-vitals Web performance metrics web-vitals
@craco/craco Create React App configuration overrider @craco/craco
@types/react TypeScript type definitions for React @types/react
@types/react-dom TypeScript type definitions for ReactDOM @types/react-dom
@vitejs/plugin-react Vite plugin for React apps @vitejs/plugin-react
eslint JavaScript linter eslint
eslint-plugin-react ESLint plugin for React eslint-plugin-react
eslint-plugin-react-hooks ESLint plugin for React Hooks eslint-plugin-react-hooks
eslint-plugin-react-refresh ESLint plugin for React Refresh eslint-plugin-react-refresh
vite Frontend build tool vite
Netlify Web hosting and automation platform Netlify

🖥️Installation

Users can clone the code and run npm install to install the dependencies

 npm install 

Afterwards users can run the command npm run build which will run the Vite build process which will bundle the React source code

npm run build

Afterwards users can run the command npm run dev which will executes the vite command, which starts the development server provided by Vite
and allows users to run the code on their local host

npm run dev

This sequence ensures that your client-side code is built before starting the server.

Package.json dependencies ⚙️ Screenshot of Header Package

💬Usage

Have a look around!! Link to deployed application https://business-cards-generator.netlify.app

🖼️Screenshot

Screenshot of Header Header

Screenshot of Form Form

📹Video

GIF Showing npm run dev Homepage, form input and download feature as well as Email functionality GIF

⚖️License

This project is licensed under MIT

🤝Contributing

Brian Trang

🛠️Tests

N/A

❔Questions

If you have any questions about this project, please contact me directly at brian.trang9@gmail.com. Feel free to view more of my projects at https://github.com/MakeRedundant.

About

Create quick business cards on the fly

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published