/EasyWords

๐Ÿ—’๏ธ A minimalist English word collection Chrome extension.

Primary LanguageTypeScript

What is ๐Ÿ“”EasyWords?

This is a minimalist Chrome extension that allows you to select and collect English words from any webpage. It's perfect for saving unfamiliar English words, and you can also manage your collected words within this extension.

EasyWords is created using Vite + React + TypeScript + TailwindCSS + shadcn/ui.

Getting Started

Prerequisites

Make sure you have Node.js (version 18+ or 20+) installed on your machine.

Setup

  1. Clone or fork the repository :

    # To clone
    git clone https://github.com/foxlau/EasyWords
    cd EasyWords
  2. Install the dependencies:

    npm install

๐Ÿ—๏ธ Development

To start the development server:

npm run dev

This will start the Vite development server and open your default browser.

๐Ÿ“ฆ Build

To create a production build:

npm run build

This will generate the build files in the build directory.

๐Ÿ“‚ Load Extension in Chrome

  1. Open Chrome and navigate to chrome://extensions/.
  2. Enable "Developer mode" using the toggle switch in the top right corner.
  3. Click "Load unpacked" and select the build directory.

Your React app should now be loaded as a Chrome extension!

๐Ÿ—‚๏ธ Project Structure

  • public/: Contains static files and the manifest.json.
  • src/: Contains the React app source code.
  • vite.config.ts: Vite configuration file.
  • tsconfig.json: TypeScript configuration file.
  • package.json: Contains the project dependencies and scripts.

License

This project is licensed under the MIT License.