Skip to content

Commit f49f5fe

Browse files
committed
Update readme
1 parent 70f6659 commit f49f5fe

File tree

1 file changed

+70
-13
lines changed

1 file changed

+70
-13
lines changed

README.md

Lines changed: 70 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
1-
# Language Learner App
1+
# Languages Learner App
22

33
## Overview
44

5-
This project is a language learning application that aims to provide an easy and effective way to learn new languages. It includes the following features:
5+
This project is a languages learning application that aims to provide an easy and effective way to learn new languages.
6+
It includes the following features:
67

78
- Profile Page: Keep track of your progress and see your achievements.
89
- Settings Page: Customize the app to your preferences.
@@ -13,14 +14,70 @@ This project is a language learning application that aims to provide an easy and
1314

1415
Check out the live demo of the app at https://languages-learner.web.app/
1516

16-
## Technologies Used
17-
18-
- [Vue 3](https://vuejs.org/)
19-
- [Vite](https://vitejs.dev/): A fast and efficient build tool for modern web development.
20-
- [Pinia](https://pinia.vuejs.org/): A lightweight state management library for Vue 3.
21-
- [i18n](https://vue-i18n.intlify.dev/): An internationalization library for Vue 3.
22-
- [Firebase](https://firebase.google.com/): A cloud-based platform for developing mobile and web applications.
23-
- [Firebase Authentication](https://firebase.google.com/docs/auth): A service that provides authentication functionality for your app.
24-
- [Firestore Database](https://firebase.google.com/docs/firestore): A cloud-based NoSQL database that provides flexible and scalable data storage.
25-
- [Firebase Remote Config](https://firebase.google.com/docs/remote-config): A service that allows you to change the behavior and appearance of your app without requiring users to download an app update.
26-
- [Naive-UI](https://www.naiveui.com/en-US/os-theme): A set of UI components for Vue 3.
17+
## 🛠 Built with
18+
19+
- [Vue 3][vue]
20+
- [Vite][vite]
21+
- [TypeScript][typescript]
22+
- [Pinia][pinia]: A lightweight state management library for Vue 3.
23+
- [i18n][i18n]: An internationalization library.
24+
- **Translations Stored in Firestore**: this allows for scalable and flexible management of multilingual content.
25+
- [Firebase][firebase]
26+
- [Firebase Authentication][firebase-authentication]
27+
- [Firestore Database][firestore-database]
28+
- [Firebase Remote Config][firebase-remote-config]
29+
- [Firebase Hosting][firebase-hosting]
30+
- [Naive-UI][naive-ui]: A set of UI components for Vue 3.
31+
32+
- [Docker][docker]
33+
- Docker Compose files provided for both development and production environments.
34+
- Although not currently in use, these Docker Compose files serve as examples for potential containerization of application in the future.
35+
36+
- **PWA Support**
37+
- [VitePWA][vite-pwa]: Integrate Progressive Web App (PWA) features
38+
39+
- **Automated Tests**
40+
- [Vitest][vitest]: Unit and Component Tests.
41+
- [Cypress][cypress] + [Cypress Cloud][cypress-cloud]: End-to-end Tests across multiple browsers and device sizes.
42+
- **Include visual regression tests** using [cypress-visual-regression][cypress-visual-regression]
43+
44+
- **CI/CD**
45+
- Automated Tests: Unit, Component and End-to-end Tests.
46+
- Deploy:
47+
- Preview website for pull-requests and delete on PR close
48+
- Production deploy
49+
- Reject pending deployments on PR close
50+
51+
- **Code Quality Tools**
52+
- [ESLint][eslint]
53+
- [Stylelint][stylelint]
54+
55+
[vue]: https://vuejs.org/
56+
[vite]: https://vitejs.dev/
57+
[typescript]: https://typescriptlang.org
58+
[pinia]: https://pinia.vuejs.org/
59+
[i18n]: https://vue-i18n.intlify.dev/
60+
[firebase]: https://firebase.google.com/
61+
[firebase-authentication]: https://firebase.google.com/docs/auth
62+
[firestore-database]: https://firebase.google.com/docs/firestore
63+
[firebase-remote-config]: https://firebase.google.com/docs/remote-config
64+
[firebase-hosting]: https://firebase.google.com/docs/hosting
65+
[naive-ui]: https://www.naiveui.com/en-US/os-theme
66+
[docker]: https://www.docker.com/
67+
[vite-pwa]: https://github.com/antfu/vite-plugin-pwa
68+
[vitest]: https://vitest.dev/
69+
[cypress]: https://www.cypress.io/
70+
[cypress-cloud]: https://cloud.cypress.io/projects/fm6ypm/runs
71+
[cypress-visual-regression]: https://github.com/cypress-visual-regression/cypress-visual-regression
72+
[eslint]: https://eslint.org/
73+
[stylelint]: https://stylelint.io/
74+
75+
## Preview (Mobile)
76+
77+
[//]: # (![preview-dictionary-page-mobile](public/preview-dictionary-page-mobile.png))
78+
79+
[//]: # (![preview-profile-page-mobile](public/preview-profile-page-mobile.png))
80+
<p align="center">
81+
<img src="public/preview-dictionary-page-mobile.png" alt="preview-dictionary-page-mobile" width="200" style="margin-right: 20px;">
82+
<img src="public/preview-profile-page-mobile.png" alt="preview-profile-page-mobile" width="200">
83+
</p>

0 commit comments

Comments
 (0)