Skip to content

A Developer Tool in the form of a Chrome extension that lets you generate and apply color palettes to any website with just a few clicks with high level of customization.

License

Notifications You must be signed in to change notification settings

PrajwalDhule/Chromafy

Repository files navigation

Chromafy

A Developer Tool in the form of a Web extension that lets you generate and apply color palettes to any website with just a few clicks with high level of customization.

Demo

Chromafy Demo Video

Major Links

Chrome Extension: Chrome Extension Link Firefox Add-on: Firefox Add-on link Website (docs included): Website link

Tech Stack

reactjs logo chrome logo firefox logo astro logo

Installation

i. Fork the repo into your account

ii. Clone the project into your local machine

git clone https://github.com/<Your-name>/Chromafy.git

Chromafy Extension

  1. Navigate to the folder
cd chromafy-extension

then

cd chromafy-app
  1. Install the dependencies
npm install
  1. Run the project on local machine
npm run dev

NOTE: the CSS files are located in the chromafy-extension/extension-files/styles folder

If you've made any changes

  1. Build the react app
npm run build
  1. Navigate back by one directory, and then navigate to extension-files folder
cd ..
cd extension-files
  1. Get the name of the newly built contentScript file from the assets folder inside the build (dist) folder (i.e. full path: chromafy-extension/extension-files/dist/assets/)

contentScript build file

  1. Update the previous contentScript file name with the current one in injectReactApp function inside contentScript.js (i.e. full path: chromafy-extension/extension-files/contentScript.js)

contentScript file name update

To upload the web extension and use it on your device

  1. go to chrome://extensions/ in your Chrome browser, click load unpacked and select the extension-files folder (i.e full path: chromafy-extension/extension-files)

upload_to_chrome

Chromafy Website

(From the root directory)

  1. Navigate to the folder
cd chromafy-website
  1. Install the dependencies
npm install
  1. Run the project on local machine
npm run dev

Contributing Guidelines

Thank you for considering to contribute to this project 😄

What do I need to know to contribute?

Anybody who is familiar with the project's tech stack of ReactJS/Astro/Chrome Extensions/Firefox Extensions can contribute. If you are interested to contribute and want to learn more about the technologies that are used in this project, checkout the links below.

How to make a Contribution?

Never made an open source contribution before? And wondering how to contribute to this project? No worries! Here's a quick guide,

  1. Choose any feature/bug you wanna contribute to.
  2. Fork the repository into your own account.
  3. Clone the repo you have forked in your local machine using git clone https://github.com/<Your-name>/Chromafy.git
  4. Create a new branch for your fix by using the command git checkout -b YourName-branch-name
  5. Make the changes you wanna do and stage them using the command git add files-you-have-changed or use git add .
  6. Use the git commit -m "Short description of the changes" to describe the changes you have done with a message.
  7. Push the changes to your remote repository using git push origin your-branch-name
  8. Submit a PR(pull request) to the upstream repository (PrajwalDhule/Chromafy) with a title and a small description.
  9. Wait for the pull request to be reviewed, make appropriate changes if recommended, and submit it.
  10. And your pull request is merged! Congrats 🎊

Checkout the Contributing.md file before contributing.

Where can I go for help, or just contact?

If you need help, you can email at:

Or connect with me on

License

CC BY-NC-ND

About

A Developer Tool in the form of a Chrome extension that lets you generate and apply color palettes to any website with just a few clicks with high level of customization.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published