GitCard 🚀 ⚡ 🔥

Introduction

GitCard is a small app made with ❤️ with Typescript, React, and bundled with webpack, which is basically creating a custom github card for a repository to any github user

Quick start

Just close this repo into your own repository and then let the magic start 🎆 🎉

git clone git@github.com:hamzahsn/GitCard.git
cd GitCard
npm install
npm run start:profile

After this, you should get an open navigator with the link: http://localhost:8080/ otherwise you can just go to that 🔗

and then you will have a beautiful card:

then once you have put a username and a repository and chose a color and picked a color and submitted then you will have your magic link ✨

And then you can navigate to it and you can see your magic card:

Commands:

Command	description
npm run lint	lint project
npm run lint:fix	fix lint of the project
npm run style:lint	fix styles of the project
npm run start:profile	start the app
npm run build:profile	build the app
npm run test	run test of the app
npm run test:watch	watch jest test
npm run test:coverage	run test coverage
npm run test:update	run coverage update

folder structure

I got inspired from the atomic structure to create this project, where I have put all my small components such as inputs, buttons, typography...inside Atoms folder under component, and for my small container I user Organisms for that which will hold my card basically, and I have added another page folder to contain every page that have a separate route.

Deployment application

This application is deployed by github Pages where you can see it when you navigate to this link: GitCard .

Like it?

Then just ⭐ it 😉