/iconzy

Iconzy is a personal project for customizing and browsing free icon packs for your personal projects.

Primary LanguageTypeScriptGNU General Public License v3.0GPL-3.0

Welcome to Iconzy

Version Documentation Maintenance License: MIT Twitter: faustinozanetto

✨ About

Iconzy is a project for customizing and browsing free icon packs for your personal projects.

🚀 Installation and Usage

git clone https://github.com/faustinozanetto/iconzy # First clone the repo in your folder of choice.
cd iconzy # Move into the recently cloned repo.
yarn install # Install using yarn or npm.
yarn dev # Boot up the project using the following command.

🛠️ Technologies

The project is being developed with the latest technlogoies used in the industry like:

  • TurboRepo
  • NextJS
  • Typescript
  • TailwindCSS
  • Husky
  • ESLint
  • Prettier
  • React
  • Commitlint
  • And more :)

🎛️ Project Structure

The project is a structured in a mono repo so it consists of multiple separated projects. It has two main folders called apps and packages where the core tools are built.

  • apps/web: the main Next.js app containing the frontend
  • apps/landing: the landing Next.js app for the iconzy landing page
  • packages/tsconfig: the main tsconfig has some files that describe how typescript should work for each app
  • packages/tailwind-config: the base config for the different uses of tailwindcss across the project
  • packages/eslint-config-custom: the custom eslint configuration for the project
  • packages/ui: a React component library containing common UI components like Buttons, Inputs and more

👤 Author

Faustino Zanetto