Skip to content

Latest commit

 

History

History
81 lines (63 loc) · 3.2 KB

README.md

File metadata and controls

81 lines (63 loc) · 3.2 KB

Gitmon Card Generator

Enter your github username to generate your own gitmon card.

https://gitmon-card-generator.vercel.app/

|

preview-video.mp4

Contents

Technology Stack

Tech Description
TypeScript is a statically typed superset of JavaScript that compiles to plain JavaScript.
React is a JavaScript library for building user interfaces.
Vite is a fast build tool for modern web applications.
ESLint is a pluggable and configurable linter tool for identifying and reporting on patterns in JavaScript.
Prettier is a code formatter that helps maintain consistent code style across different projects and developers.
Husky Used to run linting & formatting when code is commited.
lint-staged Tool that runs linters on files staged for commit in Git to ensure code quality before committing changes.
npm is the package manager for the Node.js ecosystem.

Usage

Prerequisites

Before setting up the project, make sure you have the following tools installed:

  • Node.js (version 14 or higher recommended)
  • Git (for cloning the repository)
  • A terminal (To enter the commands into)

Project Setup

  1. Clone the repository:
git clone https://github.com/Aebel-Shajan/gitmon-card-generator.git
  1. Navigate into the project directory:
cd gitmon-card-generator
  1. Install npm dependencies:
npm install

Running the Project

  1. Start the vite development server
npm run dev
  1. Go to http://localhost:5173/ or the link displayed in the terminal

Contributors

Contributions are more than welcome :). If you have a feature request raise an issue. Also feel free to fork and submit a pull request too.. If the precommit hooks are a pain i'll remove them.

Read CONTRIBUTING.md for more details