Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: CI

on:
push:
branches: [main]
pull_request:
branches: [main]

permissions:
contents: read

jobs:
quality:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: 20
cache: npm

- name: Install dependencies
run: npm ci

- name: Type-check and build
run: npm run check
27 changes: 12 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

### **Bilingual Speech Practice Game for Children | Детская игра для тренировки речи**

[![CI](https://github.com/serik-k/til-up/actions/workflows/ci.yml/badge.svg)](https://github.com/serik-k/til-up/actions/workflows/ci.yml)
[![Vue 3](https://img.shields.io/badge/Vue-3.5-4FC08D?style=for-the-badge&logo=vuedotjs&logoColor=white)](https://vuejs.org/)
[![TypeScript](https://img.shields.io/badge/TypeScript-5.9-3178C6?style=for-the-badge&logo=typescript&logoColor=white)](https://www.typescriptlang.org/)
[![Vite](https://img.shields.io/badge/Vite-6.0-646CFF?style=for-the-badge&logo=vite&logoColor=white)](https://vitejs.dev/)
Expand Down Expand Up @@ -141,16 +142,9 @@ flowchart LR
- **npm**: `v9.x` or higher

```bash
# 1. Clone the repository / Клонировать репозиторий
git clone https://github.com/serik-k/til-up.git

# 2. Enter project directory / Перейти в папку проекта
cd til-up

# 3. Install dependencies / Установить зависимости
npm install

# 4. Run development server / Запустить сервер разработки
npm run dev
```

Expand All @@ -161,16 +155,21 @@ npm run dev
## 🧪 Quality Checks & Build | Проверка качества и сборка

```bash
# Type check TypeScript code / Проверка типов TypeScript
# Type check
npm run type-check

# Production build / Сборка для продакшена
# Type check + production build (same command used by CI)
npm run check

# Production build
npm run build

# Local preview of production build / Предпросмотр продакшн-сборки
# Local preview
npm run preview
```

Every pull request targeting `main` runs the same type-check + production build pipeline in GitHub Actions.

---

## 🏗️ Project Structure | Структура проекта
Expand All @@ -183,9 +182,7 @@ til-up/
├── 📁 src/
│ ├── 📁 app/ # 🚀 Application shell & main view setup
│ ├── 📁 assets/ # 🎨 Static styles & global graphics
│ ├── 📁 components/
│ │ ├── 🧩 SoundPopGame.vue # 🎮 Main game core, state, & stats modal
│ │ └── 🧩 Mascot.vue # 🦊 Interactive animated kid-friendly mascot
│ ├── 📁 components/ # 🧩 Game UI and mascot components
│ ├── 📁 composables/ # 🎙️ Speech recognition & synthesis lifecycle hooks
│ ├── 📁 locales/ # 🌍 Multilingual strings (RU / KZ)
│ ├── 📁 styles/ # 💅 Tailwind & custom CSS utility styles
Expand All @@ -205,9 +202,9 @@ Contributions are welcome! If you'd like to improve **Til Up**:

1. Fork the project repository.
2. Create your feature branch (`git checkout -b feature/AmazingFeature`).
3. Run `npm run type-check` and `npm run build` to verify code quality.
3. Run `npm run check` to verify type safety and the production build.
4. Commit your changes (`git commit -m 'Add some AmazingFeature'`).
5. Push to the branch (`git checkout -b feature/AmazingFeature`).
5. Push the branch (`git push origin feature/AmazingFeature`).
6. Open a Pull Request.

> [!TIP]
Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
"dev": "vite",
"build": "vite build",
"type-check": "vue-tsc --noEmit",
"check": "npm run type-check && npm run build",
"preview": "vite preview"
},
"dependencies": {
Expand Down
Loading