Skip to content

mityaua/irregular-verbs-table

Repository files navigation

πŸ“˜ Irregular Verbs Table

An interactive web app for learning English irregular verbs.

🌐 Live Demo: mityaua.github.io/irregular-verbs-table

✨ Features

  • πŸ“š Clean and searchable table of English irregular verbs (Infinitive, Past Simple, Past Participle)
  • πŸŒ™ Toggleable light/dark theme
  • ⚑ Built with modern frontend technologies (Vue 3 + Vite + Tailwind)
  • πŸ“± Mobile responsive design

πŸ›  Tech Stack

Technology Description
Vue 3 Reactive frontend framework
TypeScript Type safety
Vite Fast build tool
Tailwind CSS Utility-first CSS
Oxlint The JavaScript Oxidation Compiler

πŸ“† Installation

Clone the repository and install dependencies:

git clone https://github.com/mityaua/irregular-verbs-table.git
cd irregular-verbs-table
npm install

πŸš€ Development

Start the dev server:

npm run dev

Open http://localhost:5173 to view it in your browser.

πŸ”§ Build

Generate a production-ready build:

npm run build

The compiled files will be in the dist/ folder.

πŸš€ Deploy to GitHub Pages

npm run deploy

Note: Ensure the base option in vite.config.ts is set correctly for GitHub Pages:

base: "/irregular-verbs-table/";

πŸ“ Project Structure

β”œβ”€β”€ public/                 # Static assets
β”œβ”€β”€ src/
β”‚   β”œβ”€β”€ assets/             # Images, icons
β”‚   β”œβ”€β”€ components/         # Vue components
β”‚   β”œβ”€β”€ data/               # JSON data of verbs
β”‚   β”œβ”€β”€ App.vue             # Root Vue component
β”‚   └── main.ts             # App entry point
β”œβ”€β”€ tailwind.config.js      # Tailwind CSS config
β”œβ”€β”€ postcss.config.js       # PostCSS config
β”œβ”€β”€ vite.config.ts          # Vite config
β”œβ”€β”€ tsconfig.json           # TypeScript config
└── ...

πŸ§ͺ Scripts

npm run lint     # Lint files
npm run format   # Format files using Prettier
npm run deploy   # Deploy to GitHub Pages

🀝 Contributing

Contributions, issues and feature requests are welcome!

  1. Fork the repository
  2. Create your branch (git checkout -b feature/YourFeature)
  3. Commit your changes (git commit -m 'Add feature')
  4. Push to the branch (git push origin feature/YourFeature)
  5. Create a new Pull Request

πŸ“„ License

This project is licensed under the MIT License.